148 lines
15 KiB
HTML
148 lines
15 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
<meta name="generator" content="rustdoc">
|
|||
|
|
<meta name="description" content="API documentation for the Rust `Field` struct in crate `serde_derive_internals`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Field">
|
|||
|
|
|
|||
|
|
<title>serde_derive_internals::attr::Field - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
|||
|
|
<script src="../../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Field</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.from_ast">from_ast</a><a href="#method.name">name</a><a href="#method.rename_by_rule">rename_by_rule</a><a href="#method.skip_serializing">skip_serializing</a><a href="#method.skip_deserializing">skip_deserializing</a><a href="#method.skip_serializing_if">skip_serializing_if</a><a href="#method.default">default</a><a href="#method.serialize_with">serialize_with</a><a href="#method.deserialize_with">deserialize_with</a><a href="#method.ser_bound">ser_bound</a><a href="#method.de_bound">de_bound</a><a href="#method.borrowed_lifetimes">borrowed_lifetimes</a><a href="#method.getter">getter</a><a href="#method.flatten">flatten</a></div></div><p class='location'><a href='../index.html'>serde_derive_internals</a>::<wbr><a href='index.html'>attr</a></p><script>window.sidebarCurrent = {name: 'Field', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../../theme.js"></script>
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>serde_derive_internals</a>::<wbr><a href='index.html'>attr</a>::<wbr><a class="struct" href=''>Field</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#713-728' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Field { /* fields omitted */ }</pre><div class='docblock'><p>Represents field attribute information</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../../serde_derive_internals/attr/struct.Field.html" title="struct serde_derive_internals::attr::Field">Field</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#740-1081' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from_ast' class="method"><span id='from_ast.v' class='invisible'><code>pub fn <a href='#method.from_ast' class='fnname'>from_ast</a>(<br> cx: &<a class="struct" href="../../serde_derive_internals/struct.Ctxt.html" title="struct serde_derive_internals::Ctxt">Ctxt</a>, <br> index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> field: &<a class="struct" href="../../syn/data/struct.Field.html" title="struct syn::data::Field">Field</a>, <br> attrs: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../serde_derive_internals/attr/struct.Variant.html" title="struct serde_derive_internals::attr::Variant">Variant</a>>, <br> container_default: &<a class="enum" href="../../serde_derive_internals/attr/enum.Default.html" title="enum serde_derive_internals::attr::Default">Default</a><br>) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#742-1023' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Extract out the <code>#[serde(...)]</code> attributes from a struct field.</p>
|
|||
|
|
</div><h4 id='method.name' class="method"><span id='name.v' class='invisible'><code>pub fn <a href='#method.name' class='fnname'>name</a>(&self) -> &<a class="struct" href="../../serde_derive_internals/attr/struct.Name.html" title="struct serde_derive_internals::attr::Name">Name</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1025-1027' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.rename_by_rule' class="method"><span id='rename_by_rule.v' class='invisible'><code>pub fn <a href='#method.rename_by_rule' class='fnname'>rename_by_rule</a>(&mut self, rule: &<a class="enum" href="../../serde_derive_internals/attr/enum.RenameRule.html" title="enum serde_derive_internals::attr::RenameRule">RenameRule</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1029-1036' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.skip_serializing' class="method"><span id='skip_serializing.v' class='invisible'><code>pub fn <a href='#method.skip_serializing' class='fnname'>skip_serializing</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1038-1040' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.skip_deserializing' class="method"><span id='skip_deserializing.v' class='invisible'><code>pub fn <a href='#method.skip_deserializing' class='fnname'>skip_deserializing</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1042-1044' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.skip_serializing_if' class="method"><span id='skip_serializing_if.v' class='invisible'><code>pub fn <a href='#method.skip_serializing_if' class='fnname'>skip_serializing_if</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../syn/expr/struct.ExprPath.html" title="struct syn::expr::ExprPath">ExprPath</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1046-1048' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>pub fn <a href='#method.default' class='fnname'>default</a>(&self) -> &<a class="enum" href="../../serde_derive_internals/attr/enum.Default.html" title="enum serde_derive_internals::attr::Default">Default</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1050-1052' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.serialize_with' class="method"><span id='serialize_with.v' class='invisible'><code>pub fn <a href='#method.serialize_with' class='fnname'>serialize_with</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../syn/expr/struct.ExprPath.html" title="struct syn::expr::ExprPath">ExprPath</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1054-1056' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.deserialize_with' class="method"><span id='deserialize_with.v' class='invisible'><code>pub fn <a href='#method.deserialize_with' class='fnname'>deserialize_with</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../syn/expr/struct.ExprPath.html" title="struct syn::expr::ExprPath">ExprPath</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1058-1060' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.ser_bound' class="method"><span id='ser_bound.v' class='invisible'><code>pub fn <a href='#method.ser_bound' class='fnname'>ser_bound</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="enum" href="../../syn/generics/enum.WherePredicate.html" title="enum syn::generics::WherePredicate">WherePredicate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1062-1064' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.de_bound' class="method"><span id='de_bound.v' class='invisible'><code>pub fn <a href='#method.de_bound' class='fnname'>de_bound</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="enum" href="../../syn/generics/enum.WherePredicate.html" title="enum syn::generics::WherePredicate">WherePredicate</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1066-1068' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.borrowed_lifetimes' class="method"><span id='borrowed_lifetimes.v' class='invisible'><code>pub fn <a href='#method.borrowed_lifetimes' class='fnname'>borrowed_lifetimes</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a><<a class="struct" href="../../syn/lifetime/struct.Lifetime.html" title="struct syn::lifetime::Lifetime">Lifetime</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1070-1072' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.getter' class="method"><span id='getter.v' class='invisible'><code>pub fn <a href='#method.getter' class='fnname'>getter</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../syn/expr/struct.ExprPath.html" title="struct syn::expr::ExprPath">ExprPath</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1074-1076' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><code>pub fn <a href='#method.flatten' class='fnname'>flatten</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_derive_internals/attr.rs.html#1078-1080' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "serde_derive_internals";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|