382 lines
No EOL
17 KiB
HTML
382 lines
No EOL
17 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 `de` mod in crate `serde`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, de">
|
||
|
||
<title>serde::de - 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 mod">
|
||
<!--[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'>Module de</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>serde</a></p><script>window.sidebarCurrent = {name: 'de', ty: 'mod', 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'>Module <a href='../index.html'>serde</a>::<wbr><a class="mod" href=''>de</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/de/mod.rs.html#9-2274' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Generic data structure deserialization framework.</p>
|
||
<p>The two most important traits in this module are <a href="../trait.Deserialize.html"><code>Deserialize</code></a> and
|
||
<a href="../trait.Deserializer.html"><code>Deserializer</code></a>.</p>
|
||
<ul>
|
||
<li><strong>A type that implements <code>Deserialize</code> is a data structure</strong> that can be
|
||
deserialized from any data format supported by Serde, and conversely</li>
|
||
<li><strong>A type that implements <code>Deserializer</code> is a data format</strong> that can
|
||
deserialize any data structure supported by Serde.</li>
|
||
</ul>
|
||
<h1 id="the-deserialize-trait" class="section-header"><a href="#the-deserialize-trait">The Deserialize trait</a></h1>
|
||
<p>Serde provides <a href="../trait.Deserialize.html"><code>Deserialize</code></a> implementations for many Rust primitive and
|
||
standard library types. The complete list is below. All of these can be
|
||
deserialized using Serde out of the box.</p>
|
||
<p>Additionally, Serde provides a procedural macro called <a href="https://crates.io/crates/serde_derive"><code>serde_derive</code></a> to
|
||
automatically generate <a href="../trait.Deserialize.html"><code>Deserialize</code></a> implementations for structs and enums
|
||
in your program. See the <a href="https://serde.rs/derive.html">derive section of the manual</a> for how to use this.</p>
|
||
<p>In rare cases it may be necessary to implement <a href="../trait.Deserialize.html"><code>Deserialize</code></a> manually for
|
||
some type in your program. See the <a href="https://serde.rs/impl-deserialize.html">Implementing <code>Deserialize</code></a> section of
|
||
the manual for more about this.</p>
|
||
<p>Third-party crates may provide <a href="../trait.Deserialize.html"><code>Deserialize</code></a> implementations for types
|
||
that they expose. For example the <a href="https://crates.io/crates/linked-hash-map"><code>linked-hash-map</code></a> crate provides a
|
||
<a href="https://docs.rs/linked-hash-map/*/linked_hash_map/struct.LinkedHashMap.html"><code>LinkedHashMap<K, V></code></a> type that is deserializable by Serde because the
|
||
crate provides an implementation of <a href="../trait.Deserialize.html"><code>Deserialize</code></a> for it.</p>
|
||
<h1 id="the-deserializer-trait" class="section-header"><a href="#the-deserializer-trait">The Deserializer trait</a></h1>
|
||
<p><a href="../trait.Deserializer.html"><code>Deserializer</code></a> implementations are provided by third-party crates, for
|
||
example <a href="https://github.com/serde-rs/json"><code>serde_json</code></a>, <a href="https://github.com/dtolnay/serde-yaml"><code>serde_yaml</code></a> and <a href="https://github.com/TyOverby/bincode"><code>bincode</code></a>.</p>
|
||
<p>A partial list of well-maintained formats is given on the <a href="https://serde.rs/#data-formats">Serde
|
||
website</a>.</p>
|
||
<h1 id="implementations-of-deserialize-provided-by-serde" class="section-header"><a href="#implementations-of-deserialize-provided-by-serde">Implementations of Deserialize provided by Serde</a></h1>
|
||
<p>This is a slightly different set of types than what is supported for
|
||
serialization. Some types can be serialized by Serde but not deserialized.
|
||
One example is <code>OsStr</code>.</p>
|
||
<ul>
|
||
<li><strong>Primitive types</strong>:
|
||
<ul>
|
||
<li>bool</li>
|
||
<li>i8, i16, i32, i64, i128, isize</li>
|
||
<li>u8, u16, u32, u64, u128, usize</li>
|
||
<li>f32, f64</li>
|
||
<li>char</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Compound types</strong>:
|
||
<ul>
|
||
<li>[T; 0] through [T; 32]</li>
|
||
<li>tuples up to size 16</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Common standard library types</strong>:
|
||
<ul>
|
||
<li>String</li>
|
||
<li>Option<T></li>
|
||
<li>Result<T, E></li>
|
||
<li>PhantomData<T></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Wrapper types</strong>:
|
||
<ul>
|
||
<li>Box<T></li>
|
||
<li>Box<[T]></li>
|
||
<li>Box<str></li>
|
||
<li>Rc<T></li>
|
||
<li>Arc<T></li>
|
||
<li>Cow<'a, T></li>
|
||
<li>Cell<T></li>
|
||
<li>RefCell<T></li>
|
||
<li>Mutex<T></li>
|
||
<li>RwLock<T></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Collection types</strong>:
|
||
<ul>
|
||
<li>BTreeMap<K, V></li>
|
||
<li>BTreeSet<T></li>
|
||
<li>BinaryHeap<T></li>
|
||
<li>HashMap<K, V, H></li>
|
||
<li>HashSet<T, H></li>
|
||
<li>LinkedList<T></li>
|
||
<li>VecDeque<T></li>
|
||
<li>Vec<T></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Zero-copy types</strong>:
|
||
<ul>
|
||
<li>&str</li>
|
||
<li>&[u8]</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>FFI types</strong>:
|
||
<ul>
|
||
<li>CString</li>
|
||
<li>Box<CStr></li>
|
||
<li>OsString</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Miscellaneous standard library types</strong>:
|
||
<ul>
|
||
<li>Duration</li>
|
||
<li>SystemTime</li>
|
||
<li>Path</li>
|
||
<li>PathBuf</li>
|
||
<li>Range<T></li>
|
||
<li>RangeInclusive<T></li>
|
||
<li>num::NonZero*</li>
|
||
<li><code>!</code> <em>(unstable)</em></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Net types</strong>:
|
||
<ul>
|
||
<li>IpAddr</li>
|
||
<li>Ipv4Addr</li>
|
||
<li>Ipv6Addr</li>
|
||
<li>SocketAddr</li>
|
||
<li>SocketAddrV4</li>
|
||
<li>SocketAddrV6</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="value/index.html"
|
||
title='mod serde::de::value'>value</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Building blocks for deserializing basic values using the <code>IntoDeserializer</code>
|
||
trait.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IgnoredAny.html"
|
||
title='struct serde::de::IgnoredAny'>IgnoredAny</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An efficient way of discarding data from a deserializer.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="enum" href="enum.Unexpected.html"
|
||
title='enum serde::de::Unexpected'>Unexpected</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>Unexpected</code> represents an unexpected invocation of any one of the <code>Visitor</code>
|
||
trait methods.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Deserialize.html"
|
||
title='trait serde::de::Deserialize'>Deserialize</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <strong>data structure</strong> that can be deserialized from any data format supported
|
||
by Serde.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.DeserializeOwned.html"
|
||
title='trait serde::de::DeserializeOwned'>DeserializeOwned</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A data structure that can be deserialized without borrowing any data from
|
||
the deserializer.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.DeserializeSeed.html"
|
||
title='trait serde::de::DeserializeSeed'>DeserializeSeed</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>DeserializeSeed</code> is the stateful form of the <code>Deserialize</code> trait. If you
|
||
ever find yourself looking for a way to pass data into a <code>Deserialize</code> impl,
|
||
this trait is the way to do it.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Deserializer.html"
|
||
title='trait serde::de::Deserializer'>Deserializer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A <strong>data format</strong> that can deserialize any data structure supported by
|
||
Serde.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.EnumAccess.html"
|
||
title='trait serde::de::EnumAccess'>EnumAccess</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Provides a <code>Visitor</code> access to the data of an enum in the input.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Error.html"
|
||
title='trait serde::de::Error'>Error</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The <code>Error</code> trait allows <code>Deserialize</code> implementations to create descriptive
|
||
error messages belonging to the <code>Deserializer</code> against which they are
|
||
currently running.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Expected.html"
|
||
title='trait serde::de::Expected'>Expected</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>Expected</code> represents an explanation of what data a <code>Visitor</code> was expecting
|
||
to receive.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.IntoDeserializer.html"
|
||
title='trait serde::de::IntoDeserializer'>IntoDeserializer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Converts an existing value into a <code>Deserializer</code> from which other values can
|
||
be deserialized.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.MapAccess.html"
|
||
title='trait serde::de::MapAccess'>MapAccess</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Provides a <code>Visitor</code> access to each entry of a map in the input.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.SeqAccess.html"
|
||
title='trait serde::de::SeqAccess'>SeqAccess</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Provides a <code>Visitor</code> access to each element of a sequence in the input.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.VariantAccess.html"
|
||
title='trait serde::de::VariantAccess'>VariantAccess</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>VariantAccess</code> is a visitor that is created by the <code>Deserializer</code> and
|
||
passed to the <code>Deserialize</code> to deserialize the content of a particular enum
|
||
variant.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.Visitor.html"
|
||
title='trait serde::de::Visitor'>Visitor</a></td>
|
||
<td class='docblock-short'>
|
||
<p>This trait represents a visitor that walks through a deserializer.</p>
|
||
|
||
</td>
|
||
</tr></table></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";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |