370 lines
82 KiB
HTML
370 lines
82 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 `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="../main.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 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">
|
|||
|
|
</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#505-799' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait Decoder {
|
|||
|
|
type <a href='#associatedtype.Error' class="type">Error</a>;
|
|||
|
|
fn <a href='#tymethod.read_nil' class='fnname'>read_nil</a>(&mut self) -> <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.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_usize' class='fnname'>read_usize</a>(&mut self) -> <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>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_u64' class='fnname'>read_u64</a>(&mut self) -> <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.u64.html">u64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_u32' class='fnname'>read_u32</a>(&mut self) -> <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.u32.html">u32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_u16' class='fnname'>read_u16</a>(&mut self) -> <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.u16.html">u16</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_u8' class='fnname'>read_u8</a>(&mut self) -> <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>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_isize' class='fnname'>read_isize</a>(&mut self) -> <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.isize.html">isize</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_i64' class='fnname'>read_i64</a>(&mut self) -> <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.i64.html">i64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_i32' class='fnname'>read_i32</a>(&mut self) -> <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.i32.html">i32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_i16' class='fnname'>read_i16</a>(&mut self) -> <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.i16.html">i16</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_i8' class='fnname'>read_i8</a>(&mut self) -> <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.i8.html">i8</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_bool' class='fnname'>read_bool</a>(&mut self) -> <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.bool.html">bool</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_f64' class='fnname'>read_f64</a>(&mut self) -> <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.f64.html">f64</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_f32' class='fnname'>read_f32</a>(&mut self) -> <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.f32.html">f32</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_char' class='fnname'>read_char</a>(&mut self) -> <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.char.html">char</a>, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_str' class='fnname'>read_str</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_enum' class='fnname'>read_enum</a><T, F>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_enum_variant' class='fnname'>read_enum_variant</a><T, F>(<br> &mut self, <br> names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>&<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> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_enum_variant_arg' class='fnname'>read_enum_variant_arg</a><T, F>(<br> &mut self, <br> a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_enum_struct_variant' class='fnname'>read_enum_struct_variant</a><T, F>(<br> &mut self, <br> names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>&<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> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_enum_struct_variant_field' class='fnname'>read_enum_struct_variant_field</a><T, F>(<br> &mut self, <br> f_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_struct' class='fnname'>read_struct</a><T, F>(<br> &mut self, <br> s_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_struct_field' class='fnname'>read_struct_field</a><T, F>(<br> &mut self, <br> f_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_tuple' class='fnname'>read_tuple</a><T, F>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_tuple_arg' class='fnname'>read_tuple_arg</a><T, F>(<br> &mut self, <br> a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_tuple_struct' class='fnname'>read_tuple_struct</a><T, F>(<br> &mut self, <br> s_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_tuple_struct_arg' class='fnname'>read_tuple_struct_arg</a><T, F>(<br> &mut self, <br> a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_option' class='fnname'>read_option</a><T, F>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_seq' class='fnname'>read_seq</a><T, F>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_seq_elt' class='fnname'>read_seq_elt</a><T, F>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_map' class='fnname'>read_map</a><T, F>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_map_elt_key' class='fnname'>read_map_elt_key</a><T, F>(<br> &mut self, <br> idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.read_map_elt_val' class='fnname'>read_map_elt_val</a><T, F>(<br> &mut self, <br> idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>><br> <span class="where">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>></span>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.error' class='fnname'>error</a>(&mut self, err: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>;
|
|||
|
|
}</pre><div class='docblock'><p>Trait for reading in an encoding for deserialization.</p>
|
|||
|
|
<p>This trait provides methods to decode basic types and generic forms of
|
|||
|
|
collections. Implementations of <code>Decodable</code> use it to perform the actual
|
|||
|
|
decoding of a type.</p>
|
|||
|
|
<p>Note that, as is typical with deserialization, the design of this API
|
|||
|
|
assumes you know in advance the form of the data you are decoding (ie: what
|
|||
|
|
type is encoded).</p>
|
|||
|
|
<p>Decoders can expect to only have a single "root" method call made on this
|
|||
|
|
trait. Non-trivial types will call one of the collection-reading methods,
|
|||
|
|
passing a function that may call other methods on the trait, but once the
|
|||
|
|
collection-reading method has returned, decoding should be complete.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<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>
|
|||
|
|
</div></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.read_nil' class='method'><span id='read_nil.v' class='invisible'><code>fn <a href='#tymethod.read_nil' class='fnname'>read_nil</a>(&mut self) -> <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.unit.html">()</a>, 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>Read a nil value.</p>
|
|||
|
|
</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>(&mut self) -> <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>, 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>Read a usize value.</p>
|
|||
|
|
</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>(&mut self) -> <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.u64.html">u64</a>, 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>Read a u64 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.u32.html">u32</a>, 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>Read a u32 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.u16.html">u16</a>, 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>Read a u16 value.</p>
|
|||
|
|
</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>(&mut self) -> <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>, 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>Read a u8 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.isize.html">isize</a>, 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>Read a isize value.</p>
|
|||
|
|
</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>(&mut self) -> <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.i64.html">i64</a>, 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>Read a i64 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.i32.html">i32</a>, 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>Read a i32 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.i16.html">i16</a>, 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>Read a i16 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.i8.html">i8</a>, 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>Read a i8 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.bool.html">bool</a>, 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>Read a bool value.</p>
|
|||
|
|
</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>(&mut self) -> <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.f64.html">f64</a>, 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>Read a f64 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.f32.html">f32</a>, 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>Read a f32 value.</p>
|
|||
|
|
</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>(&mut self) -> <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.char.html">char</a>, 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>Read a char value.</p>
|
|||
|
|
</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>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></code></span></h3><div class='docblock'><p>Read a string value.</p>
|
|||
|
|
</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><T, F>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an enumeration value.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>name</code> indicates the enumeration type name. It may be used to
|
|||
|
|
sanity-check the data being read.</li>
|
|||
|
|
<li><code>f</code> is a function that will call <code>read_enum_variant</code> (or
|
|||
|
|
<code>read_enum_struct_variant</code>) to read the actual value.</li>
|
|||
|
|
</ul>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>&<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> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an enumeration value.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>names</code> is a list of the enumeration variant names.</li>
|
|||
|
|
<li><code>f</code> is a function that will call <code>read_enum_variant_arg</code> or
|
|||
|
|
<code>read_enum_struct_variant_field</code> as appropriate to read the
|
|||
|
|
associated values. It will be passed the index into <code>names</code> for the
|
|||
|
|
variant that is encoded.</li>
|
|||
|
|
</ul>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an unnamed data item for an enumeration variant.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_enum_variant</code>
|
|||
|
|
or <code>read_enum_struct_variant</code>, and only when the index provided to that
|
|||
|
|
function indicates that the variant has associated unnamed data. It
|
|||
|
|
should be called once for each associated data item.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>a_idx</code> is the (zero-based) index of the data item.</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to deocde
|
|||
|
|
the data object.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that variant data items must be read in order - starting with index
|
|||
|
|
<code>0</code> and finishing with index <code>len-1</code>. Implementations may use <code>a_idx</code>,
|
|||
|
|
the call order or both to select the correct data to decode.</p>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> names: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>&<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> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an enumeration value.</p>
|
|||
|
|
<p>This is identical to <code>read_enum_variant</code>, and is only provided for
|
|||
|
|
symmetry with the <code>Encoder</code> API.</p>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> f_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a named data item for an enumeration variant.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_enum_variant</code>
|
|||
|
|
or <code>read_enum_struct_variant</code>, and only when the index provided to that
|
|||
|
|
function indicates that the variant has associated named data. It should
|
|||
|
|
be called once for each associated field.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>f_name</code> is the name of the field.</li>
|
|||
|
|
<li><code>f_idx</code> is the (zero-based) index of the data item.</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to deocde
|
|||
|
|
the data object.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that fields must be read in order - starting with index <code>0</code> and
|
|||
|
|
finishing with index <code>len-1</code>. Implementations may use <code>f_idx</code>, <code>f_name</code>,
|
|||
|
|
the call order or any combination to choose the correct data to decode,
|
|||
|
|
and may (but are not required to) return an error if these are
|
|||
|
|
inconsistent.</p>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> s_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an struct value.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>s_name</code> indicates the struct type name. It may be used to
|
|||
|
|
sanity-check the data being read.</li>
|
|||
|
|
<li><code>len</code> indicates the number of fields in the struct.</li>
|
|||
|
|
<li><code>f</code> is a function that will call <code>read_struct_field</code> for each field in
|
|||
|
|
the struct.</li>
|
|||
|
|
</ul>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> f_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> f_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a field for a struct value.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_struct</code>. It
|
|||
|
|
should be called once for each associated field.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>f_name</code> is the name of the field.</li>
|
|||
|
|
<li><code>f_idx</code> is the (zero-based) index of the data item.</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to deocde
|
|||
|
|
the data object.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that fields must be read in order - starting with index <code>0</code> and
|
|||
|
|
finishing with index <code>len-1</code>. Implementations may use <code>f_idx</code>, <code>f_name</code>,
|
|||
|
|
the call order or any combination to choose the correct data to decode,
|
|||
|
|
and may (but are not required to) return an error if these are
|
|||
|
|
inconsistent.</p>
|
|||
|
|
</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><T, F>(&mut self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a tuple value.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>len</code> is the number of items in the tuple.</li>
|
|||
|
|
<li><code>f</code> is a function that will call <code>read_tuple_arg</code> for each item in the
|
|||
|
|
tuple.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that external <code>Decodable</code> implementations should not normally need
|
|||
|
|
to use this method directly; it is meant for the use of this module's
|
|||
|
|
own implementation of <code>Decodable</code> for tuples.</p>
|
|||
|
|
</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><T, F>(&mut self, a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a data item for a tuple.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_tuple</code>.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>a_idx</code> is the (zero-based) index of the data item.</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to encode
|
|||
|
|
the data object.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that tuple items must be read in order - starting with index <code>0</code>
|
|||
|
|
and finishing with index <code>len-1</code>.</p>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> s_name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a tuple struct value.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>s_name</code> is the name of the tuple struct.</li>
|
|||
|
|
<li><code>len</code> is the number of items in the tuple struct.</li>
|
|||
|
|
<li><code>f</code> is a function that calls <code>read_tuple_struct_arg</code> for each member.</li>
|
|||
|
|
</ul>
|
|||
|
|
</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><T, F>(<br> &mut self, <br> a_idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> f: F<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a data item for a tuple struct.</p>
|
|||
|
|
<p>This should only be called from a function passed to
|
|||
|
|
<code>read_tuple_struct</code>.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>a_idx</code> is the (zero-based) index of the data item.</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to encode
|
|||
|
|
the data object.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that tuple struct items must be read in order - starting with index
|
|||
|
|
<code>0</code> and finishing with index <code>len-1</code>.</p>
|
|||
|
|
</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><T, F>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an optional value.</p>
|
|||
|
|
<p><code>f</code> is a function that will will be passed be passed <code>false</code> if the
|
|||
|
|
value is unset, and <code>true</code> if it is set. If the function is passed
|
|||
|
|
<code>true</code>, it will call the appropriate read methods to read the associated
|
|||
|
|
data type.</p>
|
|||
|
|
<p>This method allows decoders to handle <code>Option<T></code> values specially,
|
|||
|
|
rather than using the generic enum methods, because many encoding
|
|||
|
|
formats have a built-in "optional" concept.</p>
|
|||
|
|
<p>Note that external <code>Decodable</code> implementations should not normally need
|
|||
|
|
to use this method directly; it is meant for the use of this module's
|
|||
|
|
own implementation of <code>Decodable</code> for <code>Option<T></code>.</p>
|
|||
|
|
</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><T, F>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read a sequence of values.</p>
|
|||
|
|
<p>This should be used for both array-like ordered sequences and set-like
|
|||
|
|
unordered ones.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>f</code> is a function that will be passed the length of the sequence, and
|
|||
|
|
will call <code>read_seq_elt</code> for each value in the sequence.</li>
|
|||
|
|
</ul>
|
|||
|
|
</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><T, F>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an element in the sequence.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_seq</code>.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>idx</code> is the (zero-based) index of the value in the sequence.</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to decode
|
|||
|
|
the data object.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that sequence elements must be read in order - starting with index
|
|||
|
|
<code>0</code> and finishing with index <code>len-1</code>.</p>
|
|||
|
|
</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><T, F>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read an associative container (map).</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>f</code> is a function that will be passed the number of entries in the
|
|||
|
|
map, and will call <code>read_map_elt_key</code> and <code>read_map_elt_val</code> to decode
|
|||
|
|
each entry.</li>
|
|||
|
|
</ul>
|
|||
|
|
</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><T, F>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read the key for an entry in a map.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_map</code>.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>idx</code> is the (zero-based) index of the entry in the map</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to decode
|
|||
|
|
the key.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that map entries must be read in order - starting with index <code>0</code>
|
|||
|
|
and finishing with index <code>len-1</code> - and for each entry, the key should be
|
|||
|
|
read followed immediately by the value.</p>
|
|||
|
|
</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><T, F>(&mut self, idx: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>> <span class="where fmt-newline">where<br> 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">&mut </a>Self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, Self::<a class="type" href="../rustc_serialize/trait.Decoder.html#associatedtype.Error" title="type rustc_serialize::Decoder::Error">Error</a>>, </span></code></span></h3><div class='docblock'><p>Read the value for an entry in a map.</p>
|
|||
|
|
<p>This should only be called from a function passed to <code>read_map</code>.</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>idx</code> is the (zero-based) index of the entry in the map</li>
|
|||
|
|
<li><code>f</code> is a function that will call the appropriate read method to decode
|
|||
|
|
the value.</li>
|
|||
|
|
</ul>
|
|||
|
|
<p>Note that map entries must be read in order - starting with index <code>0</code>
|
|||
|
|
and finishing with index <code>len-1</code> - and for each entry, the key should be
|
|||
|
|
read followed immediately by the value.</p>
|
|||
|
|
</div><h3 id='tymethod.error' class='method'><span id='error.v' class='invisible'><code>fn <a href='#tymethod.error' class='fnname'>error</a>(&mut self, err: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> 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>
|
|||
|
|
<p>This allows <code>Decodable</code> implementations to report an error using a
|
|||
|
|
<code>Decoder</code> implementation's error type when inconsistent data is read.
|
|||
|
|
For example, when reading a fixed-length array and the wrong length is
|
|||
|
|
given by <code>read_seq</code>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../src/rustc_serialize/json.rs.html#2118-2376' title='goto source code'>[src]</a></div><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></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../implementors/rustc_serialize/trait.Decoder.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>
|