mentat/serde/de/value/index.html

369 lines
18 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!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 `value` mod in crate `serde`.">
<meta name="keywords" content="rust, rustlang, rust-lang, value">
<title>serde::de::value - 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">&#9776;</div>
<p class='location'>Module value</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../../index.html'>serde</a>::<wbr><a href='../index.html'>de</a></p><script>window.sidebarCurrent = {name: 'value', 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 href='../index.html'>de</a>::<wbr><a class="mod" href=''>value</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../../src/serde/de/value.rs.html#9-1395' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Building blocks for deserializing basic values using the <code>IntoDeserializer</code>
trait.</p>
<pre class="rust rust-example-rendered">
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_derive</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">str</span>::<span class="ident">FromStr</span>;
<span class="kw">use</span> <span class="ident">serde</span>::<span class="ident">de</span>::{<span class="ident">value</span>, <span class="ident">Deserialize</span>, <span class="ident">IntoDeserializer</span>};
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Deserialize</span>)]</span>
<span class="kw">enum</span> <span class="ident">Setting</span> {
<span class="ident">On</span>,
<span class="ident">Off</span>,
}
<span class="kw">impl</span> <span class="ident">FromStr</span> <span class="kw">for</span> <span class="ident">Setting</span> {
<span class="kw">type</span> <span class="prelude-val">Err</span> <span class="op">=</span> <span class="ident">value</span>::<span class="ident">Error</span>;
<span class="kw">fn</span> <span class="ident">from_str</span>(<span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="self">Self</span>, <span class="self">Self</span>::<span class="prelude-val">Err</span><span class="op">&gt;</span> {
<span class="self">Self</span>::<span class="ident">deserialize</span>(<span class="ident">s</span>.<span class="ident">into_deserializer</span>())
}
}</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.BoolDeserializer.html"
title='struct serde::de::value::BoolDeserializer'>BoolDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
a <code>bool</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.BorrowedBytesDeserializer.html"
title='struct serde::de::value::BorrowedBytesDeserializer'>BorrowedBytesDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>&amp;[u8]</code> with a lifetime tied to another
deserializer.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.BorrowedStrDeserializer.html"
title='struct serde::de::value::BorrowedStrDeserializer'>BorrowedStrDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>&amp;str</code> with a lifetime tied to another
deserializer.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.CharDeserializer.html"
title='struct serde::de::value::CharDeserializer'>CharDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
a <code>char</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.CowStrDeserializer.html"
title='struct serde::de::value::CowStrDeserializer'>CowStrDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>Cow&lt;str&gt;</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Error.html"
title='struct serde::de::value::Error'>Error</a></td>
<td class='docblock-short'>
<p>A minimal representation of all possible errors that can occur using the
<code>IntoDeserializer</code> trait.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.F32Deserializer.html"
title='struct serde::de::value::F32Deserializer'>F32Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>f32</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.F64Deserializer.html"
title='struct serde::de::value::F64Deserializer'>F64Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>f64</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.I16Deserializer.html"
title='struct serde::de::value::I16Deserializer'>I16Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>i16</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.I32Deserializer.html"
title='struct serde::de::value::I32Deserializer'>I32Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>i32</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.I64Deserializer.html"
title='struct serde::de::value::I64Deserializer'>I64Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>i64</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.I8Deserializer.html"
title='struct serde::de::value::I8Deserializer'>I8Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>i8</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.IsizeDeserializer.html"
title='struct serde::de::value::IsizeDeserializer'>IsizeDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
an <code>isize</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.MapAccessDeserializer.html"
title='struct serde::de::value::MapAccessDeserializer'>MapAccessDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>MapAccess</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.MapDeserializer.html"
title='struct serde::de::value::MapDeserializer'>MapDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer that iterates over a map.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SeqAccessDeserializer.html"
title='struct serde::de::value::SeqAccessDeserializer'>SeqAccessDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>SeqAccess</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SeqDeserializer.html"
title='struct serde::de::value::SeqDeserializer'>SeqDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer that iterates over a sequence.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.StrDeserializer.html"
title='struct serde::de::value::StrDeserializer'>StrDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>&amp;str</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.StringDeserializer.html"
title='struct serde::de::value::StringDeserializer'>StringDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>String</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.U16Deserializer.html"
title='struct serde::de::value::U16Deserializer'>U16Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
a <code>u16</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.U32Deserializer.html"
title='struct serde::de::value::U32Deserializer'>U32Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>u32</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.U64Deserializer.html"
title='struct serde::de::value::U64Deserializer'>U64Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
a <code>u64</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.U8Deserializer.html"
title='struct serde::de::value::U8Deserializer'>U8Deserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
a <code>u8</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.UnitDeserializer.html"
title='struct serde::de::value::UnitDeserializer'>UnitDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding a <code>()</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.UsizeDeserializer.html"
title='struct serde::de::value::UsizeDeserializer'>UsizeDeserializer</a></td>
<td class='docblock-short'>
<p>A deserializer holding
a <code>usize</code>.</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>&#9166;</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>