182 lines
175 KiB
HTML
182 lines
175 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 `Decodable` trait in crate `rustc_serialize`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Decodable">
|
|||
|
|
|
|||
|
|
<title>rustc_serialize::Decodable - 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="../light.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc trait">
|
|||
|
|
<!--[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>
|
|||
|
|
<a href='../rustc_serialize/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
|
|||
|
|
<p class='location'>Trait Decodable</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.decode">decode</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Decodable">usize</a><a href="#impl-Decodable">u8</a><a href="#impl-Decodable">u16</a><a href="#impl-Decodable">u32</a><a href="#impl-Decodable">u64</a><a href="#impl-Decodable">isize</a><a href="#impl-Decodable">i8</a><a href="#impl-Decodable">i16</a><a href="#impl-Decodable">i32</a><a href="#impl-Decodable">i64</a><a href="#impl-Decodable">String</a><a href="#impl-Decodable">f32</a><a href="#impl-Decodable">f64</a><a href="#impl-Decodable">bool</a><a href="#impl-Decodable">char</a><a href="#impl-Decodable">()</a><a href="#impl-Decodable">Box<T></a><a href="#impl-Decodable">Box<[T]></a><a href="#impl-Decodable">Rc<T></a><a href="#impl-Decodable">Cow<'a, T></a><a href="#impl-Decodable">Vec<T></a><a href="#impl-Decodable">Option<T></a><a href="#impl-Decodable">Result<T, E></a><a href="#impl-Decodable">PhantomData<T></a><a href="#impl-Decodable">(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T3, T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T6, T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T7, T8, T9, T10, T11)</a><a href="#impl-Decodable">(T8, T9, T10, T11)</a><a href="#impl-Decodable">(T9, T10, T11)</a><a href="#impl-Decodable">(T10, T11)</a><a href="#impl-Decodable">(T11,)</a><a href="#impl-Decodable">[T; 32]</a><a href="#impl-Decodable">[T; 31]</a><a href="#impl-Decodable">[T; 30]</a><a href="#impl-Decodable">[T; 29]</a><a href="#impl-Decodable">[T; 28]</a><a href="#impl-Decodable">[T; 27]</a><a href="#impl-Decodable">[T; 26]</a><a href="#impl-Decodable">[T; 25]</a><a href="#impl-Decodable">[T; 24]</a><a href="#impl-Decodable">[T; 23]</a><a href="#impl-Decodable">[T; 22]</a><a href="#impl-Decodable">[T; 21]</a><a href="#impl-Decodable">[T; 20]</a><a href="#impl-Decodable">[T; 19]</a><a href="#impl-Decodable">[T; 18]</a><a href="#impl-Decodable">[T; 17]</a><a href="#impl-Decodable">[T; 16]</a><a href="#impl-Decodable">[T; 15]</a><a href="#impl-Decodable">[T; 14]</a><a href="#impl-Decodable">[T; 13]</a><a href="#impl-Decodable">[T; 12]</a><a href="#impl-Decodable">[T; 11]</a><a href="#impl-Decodable">[T; 10]</a><a href="#impl-Decodable">[T; 9]</a><a href="#impl-Decodable">[T; 8]</a><a href="#impl-Decodable">[T; 7]</a><a href="#impl-Decodable">[T; 6]</a><a href="#impl-Decodable">[T; 5]</a><a href="#impl-Decodable">[T; 4]</a><a href="#impl-Decodable">[T; 3]</a><a href="#impl-Decodable">[T; 2]</a><a href="#impl-Decodable">[T; 1]</a><a href="#impl-Decodable">[T; 0]</a><a href="#impl-Decodable">PathBuf</a><a href="#impl-Decodable">Cell<T></a><a href="#impl-Decodable">RefCell<T></a><a href="#impl-Decodable">Arc<T></a><a href="#impl-Decodable">LinkedList<T></a><a href="#impl-Decodable">VecDeque<T></a><a href="#impl-Decodable">BTreeMap<K, V></a><a href="#impl-Decodable">BTreeSet<T></a><a href="#impl-Decodable">HashMap<K, V></a><a href="#impl-Decodable">HashSet<T></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>rustc_serialize</a></p><script>window.sidebarCurrent = {name: 'Decodable', ty: 'trait', 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'>Trait <a href='index.html'>rustc_serialize</a>::<wbr><a class="trait" href=''>Decodable</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/rustc_serialize/serialize.rs.html#902-905' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Decodable: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|||
|
|
fn <a href='#tymethod.decode' class='fnname'>decode</a><D: <a class="trait" href="../rustc_serialize/trait.Decoder.html" title="trait rustc_serialize::Decoder">Decoder</a>>(d: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>D) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, D::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
}</pre></div><div class='docblock'><p>Trait for deserializing a type.</p>
|
|||
|
|
<p>This can be implemented for custom data types to allow them to be decoded
|
|||
|
|
with <code>Decoder</code> implementations. Most of Rust's built-in or standard data
|
|||
|
|
types (like <code>i32</code> and <code>Vec<T></code>) have <code>Decodable</code> implementations provided by
|
|||
|
|
this module.</p>
|
|||
|
|
<p>Note that, in general, you should let the compiler implement this for you by
|
|||
|
|
using the <code>derive(RustcDecodable)</code> attribute.</p>
|
|||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
|
|||
|
|
|
|||
|
|
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">RustcDecodable</span>)]</span>
|
|||
|
|
<span class="kw">struct</span> <span class="ident">Point</span> {
|
|||
|
|
<span class="ident">x</span>: <span class="ident">i32</span>,
|
|||
|
|
<span class="ident">y</span>: <span class="ident">i32</span>,
|
|||
|
|
}</pre>
|
|||
|
|
<p>This generates code equivalent to:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Decodable</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Decoder</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">Point</span> {
|
|||
|
|
<span class="ident">x</span>: <span class="ident">i32</span>,
|
|||
|
|
<span class="ident">y</span>: <span class="ident">i32</span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span> <span class="ident">Decodable</span> <span class="kw">for</span> <span class="ident">Point</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">decode</span><span class="op"><</span><span class="ident">D</span>: <span class="ident">Decoder</span><span class="op">></span>(<span class="ident">d</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">D</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Point</span>, <span class="ident">D</span>::<span class="ident">Error</span><span class="op">></span> {
|
|||
|
|
<span class="ident">d</span>.<span class="ident">read_struct</span>(<span class="string">"Point"</span>, <span class="number">2</span>, <span class="op">|</span><span class="ident">d</span><span class="op">|</span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">read_struct_field</span>(<span class="string">"x"</span>, <span class="number">0</span>, <span class="op">|</span><span class="ident">d</span><span class="op">|</span> { <span class="ident">d</span>.<span class="ident">read_i32</span>() }));
|
|||
|
|
<span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">d</span>.<span class="ident">read_struct_field</span>(<span class="string">"y"</span>, <span class="number">1</span>, <span class="op">|</span><span class="ident">d</span><span class="op">|</span> { <span class="ident">d</span>.<span class="ident">read_i32</span>() }));
|
|||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">Point</span>{ <span class="ident">x</span>: <span class="ident">x</span>, <span class="ident">y</span>: <span class="ident">y</span> })
|
|||
|
|
})
|
|||
|
|
}
|
|||
|
|
}</pre>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.decode' class='method'><span id='decode.v' class='invisible'><code>fn <a href='#tymethod.decode' class='fnname'>decode</a><D: <a class="trait" href="../rustc_serialize/trait.Decoder.html" title="trait rustc_serialize::Decoder">Decoder</a>>(d: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>D) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, D::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></code></span></h3><div class='docblock'><p>Deserialize a value using a <code>Decoder</code>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Decodable' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../rustc_serialize/trait.Decodable.html" title="trait rustc_serialize::Decodable">Decodable</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-Decodable' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#913-917' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.decode' class="method"><span id='decode.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.decode' class='fnname'>decode</a><D: <a class="trait" href="../rustc_serialize/trait.Decoder.html" title="trait rustc_serialize::Decoder">Decoder</a>>(d: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>D) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, D::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#914-916' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Decodable-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../rustc_serialize/trait.Decodable.html" title="trait rustc_serialize::Decodable">Decodable</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-Decodable-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#925-929' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.decode-1' class="method"><span id='decode.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.decode' class='fnname'>decode</a><D: <a class="trait" href="../rustc_serialize/trait.Decoder.html" title="trait rustc_serialize::Decoder">Decoder</a>>(d: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>D) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, D::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#926-928' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-Decodable-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../rustc_serialize/trait.Decodable.html" title="trait rustc_serialize::Decodable">Decodable</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-Decodable-2' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#937-941' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.decode-2' class="method"><span id='deco
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../implementors/rustc_serialize/trait.Decodable.js">
|
|||
|
|
</script></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 = "rustc_serialize";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|