trait.Decoder.html 81 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. <!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 `Decoder` trait in crate `rustc_serialize`."><meta name="keywords" content="rust, rustlang, rust-lang, Decoder"><title>rustc_serialize::Decoder - 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">&#9776;</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 Decoder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Error">Error</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.read_nil">read_nil</a><a href="#tymethod.read_usize">read_usize</a><a href="#tymethod.read_u64">read_u64</a><a href="#tymethod.read_u32">read_u32</a><a href="#tymethod.read_u16">read_u16</a><a href="#tymethod.read_u8">read_u8</a><a href="#tymethod.read_isize">read_isize</a><a href="#tymethod.read_i64">read_i64</a><a href="#tymethod.read_i32">read_i32</a><a href="#tymethod.read_i16">read_i16</a><a href="#tymethod.read_i8">read_i8</a><a href="#tymethod.read_bool">read_bool</a><a href="#tymethod.read_f64">read_f64</a><a href="#tymethod.read_f32">read_f32</a><a href="#tymethod.read_char">read_char</a><a href="#tymethod.read_str">read_str</a><a href="#tymethod.read_enum">read_enum</a><a href="#tymethod.read_enum_variant">read_enum_variant</a><a href="#tymethod.read_enum_variant_arg">read_enum_variant_arg</a><a href="#tymethod.read_enum_struct_variant">read_enum_struct_variant</a><a href="#tymethod.read_enum_struct_variant_field">read_enum_struct_variant_field</a><a href="#tymethod.read_struct">read_struct</a><a href="#tymethod.read_struct_field">read_struct_field</a><a href="#tymethod.read_tuple">read_tuple</a><a href="#tymethod.read_tuple_arg">read_tuple_arg</a><a href="#tymethod.read_tuple_struct">read_tuple_struct</a><a href="#tymethod.read_tuple_struct_arg">read_tuple_struct_arg</a><a href="#tymethod.read_option">read_option</a><a href="#tymethod.read_seq">read_seq</a><a href="#tymethod.read_seq_elt">read_seq_elt</a><a href="#tymethod.read_map">read_map</a><a href="#tymethod.read_map_elt_key">read_map_elt_key</a><a href="#tymethod.read_map_elt_val">read_map_elt_val</a><a href="#tymethod.error">error</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: 'Decoder', 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"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></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=''>Decoder</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/rustc_serialize/serialize.rs.html#505-799' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Decoder {
  2. type <a href='#associatedtype.Error' class="type">Error</a>;
  3. fn <a href='#tymethod.read_nil' class='fnname'>read_nil</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  4. <div class='item-spacer'></div> fn <a href='#tymethod.read_usize' class='fnname'>read_usize</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  5. <div class='item-spacer'></div> fn <a href='#tymethod.read_u64' class='fnname'>read_u64</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  6. <div class='item-spacer'></div> fn <a href='#tymethod.read_u32' class='fnname'>read_u32</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  7. <div class='item-spacer'></div> fn <a href='#tymethod.read_u16' class='fnname'>read_u16</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  8. <div class='item-spacer'></div> fn <a href='#tymethod.read_u8' class='fnname'>read_u8</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  9. <div class='item-spacer'></div> fn <a href='#tymethod.read_isize' class='fnname'>read_isize</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  10. <div class='item-spacer'></div> fn <a href='#tymethod.read_i64' class='fnname'>read_i64</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  11. <div class='item-spacer'></div> fn <a href='#tymethod.read_i32' class='fnname'>read_i32</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  12. <div class='item-spacer'></div> fn <a href='#tymethod.read_i16' class='fnname'>read_i16</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  13. <div class='item-spacer'></div> fn <a href='#tymethod.read_i8' class='fnname'>read_i8</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  14. <div class='item-spacer'></div> fn <a href='#tymethod.read_bool' class='fnname'>read_bool</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  15. <div class='item-spacer'></div> fn <a href='#tymethod.read_f64' class='fnname'>read_f64</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  16. <div class='item-spacer'></div> fn <a href='#tymethod.read_f32' class='fnname'>read_f32</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  17. <div class='item-spacer'></div> fn <a href='#tymethod.read_char' class='fnname'>read_char</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  18. <div class='item-spacer'></div> fn <a href='#tymethod.read_str' class='fnname'>read_str</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;;
  19. <div class='item-spacer'></div> fn <a href='#tymethod.read_enum' class='fnname'>read_enum</a>&lt;T, F&gt;(&amp;mut self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  20. <div class='item-spacer'></div> fn <a href='#tymethod.read_enum_variant' class='fnname'>read_enum_variant</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  21. <div class='item-spacer'></div> fn <a href='#tymethod.read_enum_variant_arg' class='fnname'>read_enum_variant_arg</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  22. <div class='item-spacer'></div> fn <a href='#tymethod.read_enum_struct_variant' class='fnname'>read_enum_struct_variant</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  23. <div class='item-spacer'></div> fn <a href='#tymethod.read_enum_struct_variant_field' class='fnname'>read_enum_struct_variant_field</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  24. <div class='item-spacer'></div> fn <a href='#tymethod.read_struct' class='fnname'>read_struct</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;s_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  25. <div class='item-spacer'></div> fn <a href='#tymethod.read_struct_field' class='fnname'>read_struct_field</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  26. <div class='item-spacer'></div> fn <a href='#tymethod.read_tuple' class='fnname'>read_tuple</a>&lt;T, F&gt;(&amp;mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  27. <div class='item-spacer'></div> fn <a href='#tymethod.read_tuple_arg' class='fnname'>read_tuple_arg</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  28. <div class='item-spacer'></div> fn <a href='#tymethod.read_tuple_struct' class='fnname'>read_tuple_struct</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;s_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  29. <div class='item-spacer'></div> fn <a href='#tymethod.read_tuple_struct_arg' class='fnname'>read_tuple_struct_arg</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  30. <div class='item-spacer'></div> fn <a href='#tymethod.read_option' class='fnname'>read_option</a>&lt;T, F&gt;(&amp;mut self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  31. <div class='item-spacer'></div> fn <a href='#tymethod.read_seq' class='fnname'>read_seq</a>&lt;T, F&gt;(&amp;mut self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  32. <div class='item-spacer'></div> fn <a href='#tymethod.read_seq_elt' class='fnname'>read_seq_elt</a>&lt;T, F&gt;(&amp;mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  33. <div class='item-spacer'></div> fn <a href='#tymethod.read_map' class='fnname'>read_map</a>&lt;T, F&gt;(&amp;mut self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  34. <div class='item-spacer'></div> fn <a href='#tymethod.read_map_elt_key' class='fnname'>read_map_elt_key</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  35. <div class='item-spacer'></div> fn <a href='#tymethod.read_map_elt_val' class='fnname'>read_map_elt_val</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</span>;
  36. <div class='item-spacer'></div> fn <a href='#tymethod.error' class='fnname'>error</a>(&amp;mut self, err: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>;
  37. }</pre></div><div class='docblock'><p>Trait for reading in an encoding for deserialization.</p>
  38. <p>This trait provides methods to decode basic types and generic forms of
  39. collections. Implementations of <code>Decodable</code> use it to perform the actual
  40. decoding of a type.</p>
  41. <p>Note that, as is typical with deserialization, the design of this API
  42. assumes you know in advance the form of the data you are decoding (ie: what
  43. type is encoded).</p>
  44. <p>Decoders can expect to only have a single &quot;root&quot; method call made on this
  45. trait. Non-trivial types will call one of the collection-reading methods,
  46. passing a function that may call other methods on the trait, but once the
  47. collection-reading method has returned, decoding should be complete.</p>
  48. </div>
  49. <h2 id='associated-types' class='small-section-header'>
  50. Associated Types<a href='#associated-types' class='anchor'></a>
  51. </h2>
  52. <div class='methods'>
  53. <h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a></code></span></h3><div class='docblock'><p>The error type for method results.</p>
  54. </div></div>
  55. <h2 id='required-methods' class='small-section-header'>
  56. Required Methods<a href='#required-methods' class='anchor'></a>
  57. </h2>
  58. <div class='methods'>
  59. <h3 id='tymethod.read_nil' class='method'><span id='read_nil.v' class='invisible'><code>fn <a href='#tymethod.read_nil' class='fnname'>read_nil</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a nil value.</p>
  60. </div><h3 id='tymethod.read_usize' class='method'><span id='read_usize.v' class='invisible'><code>fn <a href='#tymethod.read_usize' class='fnname'>read_usize</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a usize value.</p>
  61. </div><h3 id='tymethod.read_u64' class='method'><span id='read_u64.v' class='invisible'><code>fn <a href='#tymethod.read_u64' class='fnname'>read_u64</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a u64 value.</p>
  62. </div><h3 id='tymethod.read_u32' class='method'><span id='read_u32.v' class='invisible'><code>fn <a href='#tymethod.read_u32' class='fnname'>read_u32</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a u32 value.</p>
  63. </div><h3 id='tymethod.read_u16' class='method'><span id='read_u16.v' class='invisible'><code>fn <a href='#tymethod.read_u16' class='fnname'>read_u16</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a u16 value.</p>
  64. </div><h3 id='tymethod.read_u8' class='method'><span id='read_u8.v' class='invisible'><code>fn <a href='#tymethod.read_u8' class='fnname'>read_u8</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a u8 value.</p>
  65. </div><h3 id='tymethod.read_isize' class='method'><span id='read_isize.v' class='invisible'><code>fn <a href='#tymethod.read_isize' class='fnname'>read_isize</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a isize value.</p>
  66. </div><h3 id='tymethod.read_i64' class='method'><span id='read_i64.v' class='invisible'><code>fn <a href='#tymethod.read_i64' class='fnname'>read_i64</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a i64 value.</p>
  67. </div><h3 id='tymethod.read_i32' class='method'><span id='read_i32.v' class='invisible'><code>fn <a href='#tymethod.read_i32' class='fnname'>read_i32</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a i32 value.</p>
  68. </div><h3 id='tymethod.read_i16' class='method'><span id='read_i16.v' class='invisible'><code>fn <a href='#tymethod.read_i16' class='fnname'>read_i16</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a i16 value.</p>
  69. </div><h3 id='tymethod.read_i8' class='method'><span id='read_i8.v' class='invisible'><code>fn <a href='#tymethod.read_i8' class='fnname'>read_i8</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a i8 value.</p>
  70. </div><h3 id='tymethod.read_bool' class='method'><span id='read_bool.v' class='invisible'><code>fn <a href='#tymethod.read_bool' class='fnname'>read_bool</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a bool value.</p>
  71. </div><h3 id='tymethod.read_f64' class='method'><span id='read_f64.v' class='invisible'><code>fn <a href='#tymethod.read_f64' class='fnname'>read_f64</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a f64 value.</p>
  72. </div><h3 id='tymethod.read_f32' class='method'><span id='read_f32.v' class='invisible'><code>fn <a href='#tymethod.read_f32' class='fnname'>read_f32</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a f32 value.</p>
  73. </div><h3 id='tymethod.read_char' class='method'><span id='read_char.v' class='invisible'><code>fn <a href='#tymethod.read_char' class='fnname'>read_char</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a char value.</p>
  74. </div><h3 id='tymethod.read_str' class='method'><span id='read_str.v' class='invisible'><code>fn <a href='#tymethod.read_str' class='fnname'>read_str</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Read a string value.</p>
  75. </div><h3 id='tymethod.read_enum' class='method'><span id='read_enum.v' class='invisible'><code>fn <a href='#tymethod.read_enum' class='fnname'>read_enum</a>&lt;T, F&gt;(&amp;mut self, name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an enumeration value.</p>
  76. <ul>
  77. <li><code>name</code> indicates the enumeration type name. It may be used to
  78. sanity-check the data being read.</li>
  79. <li><code>f</code> is a function that will call <code>read_enum_variant</code> (or
  80. <code>read_enum_struct_variant</code>) to read the actual value.</li>
  81. </ul>
  82. </div><h3 id='tymethod.read_enum_variant' class='method'><span id='read_enum_variant.v' class='invisible'><code>fn <a href='#tymethod.read_enum_variant' class='fnname'>read_enum_variant</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an enumeration value.</p>
  83. <ul>
  84. <li><code>names</code> is a list of the enumeration variant names.</li>
  85. <li><code>f</code> is a function that will call <code>read_enum_variant_arg</code> or
  86. <code>read_enum_struct_variant_field</code> as appropriate to read the
  87. associated values. It will be passed the index into <code>names</code> for the
  88. variant that is encoded.</li>
  89. </ul>
  90. </div><h3 id='tymethod.read_enum_variant_arg' class='method'><span id='read_enum_variant_arg.v' class='invisible'><code>fn <a href='#tymethod.read_enum_variant_arg' class='fnname'>read_enum_variant_arg</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an unnamed data item for an enumeration variant.</p>
  91. <p>This should only be called from a function passed to <code>read_enum_variant</code>
  92. or <code>read_enum_struct_variant</code>, and only when the index provided to that
  93. function indicates that the variant has associated unnamed data. It
  94. should be called once for each associated data item.</p>
  95. <ul>
  96. <li><code>a_idx</code> is the (zero-based) index of the data item.</li>
  97. <li><code>f</code> is a function that will call the appropriate read method to deocde
  98. the data object.</li>
  99. </ul>
  100. <p>Note that variant data items must be read in order - starting with index
  101. <code>0</code> and finishing with index <code>len-1</code>. Implementations may use <code>a_idx</code>,
  102. the call order or both to select the correct data to decode.</p>
  103. </div><h3 id='tymethod.read_enum_struct_variant' class='method'><span id='read_enum_struct_variant.v' class='invisible'><code>fn <a href='#tymethod.read_enum_struct_variant' class='fnname'>read_enum_struct_variant</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>&amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an enumeration value.</p>
  104. <p>This is identical to <code>read_enum_variant</code>, and is only provided for
  105. symmetry with the <code>Encoder</code> API.</p>
  106. </div><h3 id='tymethod.read_enum_struct_variant_field' class='method'><span id='read_enum_struct_variant_field.v' class='invisible'><code>fn <a href='#tymethod.read_enum_struct_variant_field' class='fnname'>read_enum_struct_variant_field</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;f_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a named data item for an enumeration variant.</p>
  107. <p>This should only be called from a function passed to <code>read_enum_variant</code>
  108. or <code>read_enum_struct_variant</code>, and only when the index provided to that
  109. function indicates that the variant has associated named data. It should
  110. be called once for each associated field.</p>
  111. <ul>
  112. <li><code>f_name</code> is the name of the field.</li>
  113. <li><code>f_idx</code> is the (zero-based) index of the data item.</li>
  114. <li><code>f</code> is a function that will call the appropriate read method to deocde
  115. the data object.</li>
  116. </ul>
  117. <p>Note that fields must be read in order - starting with index <code>0</code> and
  118. finishing with index <code>len-1</code>. Implementations may use <code>f_idx</code>, <code>f_name</code>,
  119. the call order or any combination to choose the correct data to decode,
  120. and may (but are not required to) return an error if these are
  121. inconsistent.</p>
  122. </div><h3 id='tymethod.read_struct' class='method'><span id='read_struct.v' class='invisible'><code>fn <a href='#tymethod.read_struct' class='fnname'>read_struct</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;s_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an struct value.</p>
  123. <ul>
  124. <li><code>s_name</code> indicates the struct type name. It may be used to
  125. sanity-check the data being read.</li>
  126. <li><code>len</code> indicates the number of fields in the struct.</li>
  127. <li><code>f</code> is a function that will call <code>read_struct_field</code> for each field in
  128. the struct.</li>
  129. </ul>
  130. </div><h3 id='tymethod.read_struct_field' class='method'><span id='read_struct_field.v' class='invisible'><code>fn <a href='#tymethod.read_struct_field' class='fnname'>read_struct_field</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;f_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a field for a struct value.</p>
  131. <p>This should only be called from a function passed to <code>read_struct</code>. It
  132. should be called once for each associated field.</p>
  133. <ul>
  134. <li><code>f_name</code> is the name of the field.</li>
  135. <li><code>f_idx</code> is the (zero-based) index of the data item.</li>
  136. <li><code>f</code> is a function that will call the appropriate read method to deocde
  137. the data object.</li>
  138. </ul>
  139. <p>Note that fields must be read in order - starting with index <code>0</code> and
  140. finishing with index <code>len-1</code>. Implementations may use <code>f_idx</code>, <code>f_name</code>,
  141. the call order or any combination to choose the correct data to decode,
  142. and may (but are not required to) return an error if these are
  143. inconsistent.</p>
  144. </div><h3 id='tymethod.read_tuple' class='method'><span id='read_tuple.v' class='invisible'><code>fn <a href='#tymethod.read_tuple' class='fnname'>read_tuple</a>&lt;T, F&gt;(&amp;mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a tuple value.</p>
  145. <ul>
  146. <li><code>len</code> is the number of items in the tuple.</li>
  147. <li><code>f</code> is a function that will call <code>read_tuple_arg</code> for each item in the
  148. tuple.</li>
  149. </ul>
  150. <p>Note that external <code>Decodable</code> implementations should not normally need
  151. to use this method directly; it is meant for the use of this module's
  152. own implementation of <code>Decodable</code> for tuples.</p>
  153. </div><h3 id='tymethod.read_tuple_arg' class='method'><span id='read_tuple_arg.v' class='invisible'><code>fn <a href='#tymethod.read_tuple_arg' class='fnname'>read_tuple_arg</a>&lt;T, F&gt;(&amp;mut self, a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a data item for a tuple.</p>
  154. <p>This should only be called from a function passed to <code>read_tuple</code>.</p>
  155. <ul>
  156. <li><code>a_idx</code> is the (zero-based) index of the data item.</li>
  157. <li><code>f</code> is a function that will call the appropriate read method to encode
  158. the data object.</li>
  159. </ul>
  160. <p>Note that tuple items must be read in order - starting with index <code>0</code>
  161. and finishing with index <code>len-1</code>.</p>
  162. </div><h3 id='tymethod.read_tuple_struct' class='method'><span id='read_tuple_struct.v' class='invisible'><code>fn <a href='#tymethod.read_tuple_struct' class='fnname'>read_tuple_struct</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;s_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a tuple struct value.</p>
  163. <ul>
  164. <li><code>s_name</code> is the name of the tuple struct.</li>
  165. <li><code>len</code> is the number of items in the tuple struct.</li>
  166. <li><code>f</code> is a function that calls <code>read_tuple_struct_arg</code> for each member.</li>
  167. </ul>
  168. </div><h3 id='tymethod.read_tuple_struct_arg' class='method'><span id='read_tuple_struct_arg.v' class='invisible'><code>fn <a href='#tymethod.read_tuple_struct_arg' class='fnname'>read_tuple_struct_arg</a>&lt;T, F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;f: F<br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a data item for a tuple struct.</p>
  169. <p>This should only be called from a function passed to
  170. <code>read_tuple_struct</code>.</p>
  171. <ul>
  172. <li><code>a_idx</code> is the (zero-based) index of the data item.</li>
  173. <li><code>f</code> is a function that will call the appropriate read method to encode
  174. the data object.</li>
  175. </ul>
  176. <p>Note that tuple struct items must be read in order - starting with index
  177. <code>0</code> and finishing with index <code>len-1</code>.</p>
  178. </div><h3 id='tymethod.read_option' class='method'><span id='read_option.v' class='invisible'><code>fn <a href='#tymethod.read_option' class='fnname'>read_option</a>&lt;T, F&gt;(&amp;mut self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an optional value.</p>
  179. <p><code>f</code> is a function that will will be passed be passed <code>false</code> if the
  180. value is unset, and <code>true</code> if it is set. If the function is passed
  181. <code>true</code>, it will call the appropriate read methods to read the associated
  182. data type.</p>
  183. <p>This method allows decoders to handle <code>Option&lt;T&gt;</code> values specially,
  184. rather than using the generic enum methods, because many encoding
  185. formats have a built-in &quot;optional&quot; concept.</p>
  186. <p>Note that external <code>Decodable</code> implementations should not normally need
  187. to use this method directly; it is meant for the use of this module's
  188. own implementation of <code>Decodable</code> for <code>Option&lt;T&gt;</code>.</p>
  189. </div><h3 id='tymethod.read_seq' class='method'><span id='read_seq.v' class='invisible'><code>fn <a href='#tymethod.read_seq' class='fnname'>read_seq</a>&lt;T, F&gt;(&amp;mut self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read a sequence of values.</p>
  190. <p>This should be used for both array-like ordered sequences and set-like
  191. unordered ones.</p>
  192. <ul>
  193. <li><code>f</code> is a function that will be passed the length of the sequence, and
  194. will call <code>read_seq_elt</code> for each value in the sequence.</li>
  195. </ul>
  196. </div><h3 id='tymethod.read_seq_elt' class='method'><span id='read_seq_elt.v' class='invisible'><code>fn <a href='#tymethod.read_seq_elt' class='fnname'>read_seq_elt</a>&lt;T, F&gt;(&amp;mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an element in the sequence.</p>
  197. <p>This should only be called from a function passed to <code>read_seq</code>.</p>
  198. <ul>
  199. <li><code>idx</code> is the (zero-based) index of the value in the sequence.</li>
  200. <li><code>f</code> is a function that will call the appropriate read method to decode
  201. the data object.</li>
  202. </ul>
  203. <p>Note that sequence elements must be read in order - starting with index
  204. <code>0</code> and finishing with index <code>len-1</code>.</p>
  205. </div><h3 id='tymethod.read_map' class='method'><span id='read_map.v' class='invisible'><code>fn <a href='#tymethod.read_map' class='fnname'>read_map</a>&lt;T, F&gt;(&amp;mut self, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read an associative container (map).</p>
  206. <ul>
  207. <li><code>f</code> is a function that will be passed the number of entries in the
  208. map, and will call <code>read_map_elt_key</code> and <code>read_map_elt_val</code> to decode
  209. each entry.</li>
  210. </ul>
  211. </div><h3 id='tymethod.read_map_elt_key' class='method'><span id='read_map_elt_key.v' class='invisible'><code>fn <a href='#tymethod.read_map_elt_key' class='fnname'>read_map_elt_key</a>&lt;T, F&gt;(&amp;mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read the key for an entry in a map.</p>
  212. <p>This should only be called from a function passed to <code>read_map</code>.</p>
  213. <ul>
  214. <li><code>idx</code> is the (zero-based) index of the entry in the map</li>
  215. <li><code>f</code> is a function that will call the appropriate read method to decode
  216. the key.</li>
  217. </ul>
  218. <p>Note that map entries must be read in order - starting with index <code>0</code>
  219. and finishing with index <code>len-1</code> - and for each entry, the key should be
  220. read followed immediately by the value.</p>
  221. </div><h3 id='tymethod.read_map_elt_val' class='method'><span id='read_map_elt_val.v' class='invisible'><code>fn <a href='#tymethod.read_map_elt_val' class='fnname'>read_map_elt_val</a>&lt;T, F&gt;(&amp;mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Read the value for an entry in a map.</p>
  222. <p>This should only be called from a function passed to <code>read_map</code>.</p>
  223. <ul>
  224. <li><code>idx</code> is the (zero-based) index of the entry in the map</li>
  225. <li><code>f</code> is a function that will call the appropriate read method to decode
  226. the value.</li>
  227. </ul>
  228. <p>Note that map entries must be read in order - starting with index <code>0</code>
  229. and finishing with index <code>len-1</code> - and for each entry, the key should be
  230. read followed immediately by the value.</p>
  231. </div><h3 id='tymethod.error' class='method'><span id='error.v' class='invisible'><code>fn <a href='#tymethod.error' class='fnname'>error</a>(&amp;mut self, err: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; Self::<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>Record a decoding error.</p>
  232. <p>This allows <code>Decodable</code> implementations to report an error using a
  233. <code>Decoder</code> implementation's error type when inconsistent data is read.
  234. For example, when reading a fixed-length array and the wrong length is
  235. given by <code>read_seq</code>.</p>
  236. </div></div>
  237. <h2 id='implementors' class='small-section-header'>
  238. Implementors<a href='#implementors' class='anchor'></a>
  239. </h2>
  240. <ul class='item-list' id='implementors-list'>
  241. <li><table class='table-display'><tbody><tr><td><code>impl Decoder for <a class="struct" href="../rustc_serialize/json/struct.Decoder.html" title="struct rustc_serialize::json::Decoder">Decoder</a><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../rustc_serialize/json/enum.DecoderError.html" title="enum rustc_serialize::json::DecoderError">DecoderError</a>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/rustc_serialize/json.rs.html#2118-2376' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
  242. </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
  243. src="../implementors/rustc_serialize/trait.Decoder.js">
  244. </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>&#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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "rustc_serialize";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>