trait.Encoder.html 108 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `Encoder` trait in crate `rustc_serialize`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, Encoder">
  9. <title>rustc_serialize::Encoder - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
  14. <script src="../storage.js"></script>
  15. <link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
  16. </head>
  17. <body class="rustdoc trait">
  18. <!--[if lte IE 8]>
  19. <div class="warning">
  20. This old browser is unsupported and will most likely display funky
  21. things.
  22. </div>
  23. <![endif]-->
  24. <nav class="sidebar">
  25. <div class="sidebar-menu">&#9776;</div>
  26. <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>
  27. <p class='location'>Trait Encoder</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.emit_nil">emit_nil</a><a href="#tymethod.emit_usize">emit_usize</a><a href="#tymethod.emit_u64">emit_u64</a><a href="#tymethod.emit_u32">emit_u32</a><a href="#tymethod.emit_u16">emit_u16</a><a href="#tymethod.emit_u8">emit_u8</a><a href="#tymethod.emit_isize">emit_isize</a><a href="#tymethod.emit_i64">emit_i64</a><a href="#tymethod.emit_i32">emit_i32</a><a href="#tymethod.emit_i16">emit_i16</a><a href="#tymethod.emit_i8">emit_i8</a><a href="#tymethod.emit_bool">emit_bool</a><a href="#tymethod.emit_f64">emit_f64</a><a href="#tymethod.emit_f32">emit_f32</a><a href="#tymethod.emit_char">emit_char</a><a href="#tymethod.emit_str">emit_str</a><a href="#tymethod.emit_enum">emit_enum</a><a href="#tymethod.emit_enum_variant">emit_enum_variant</a><a href="#tymethod.emit_enum_variant_arg">emit_enum_variant_arg</a><a href="#tymethod.emit_enum_struct_variant">emit_enum_struct_variant</a><a href="#tymethod.emit_enum_struct_variant_field">emit_enum_struct_variant_field</a><a href="#tymethod.emit_struct">emit_struct</a><a href="#tymethod.emit_struct_field">emit_struct_field</a><a href="#tymethod.emit_tuple">emit_tuple</a><a href="#tymethod.emit_tuple_arg">emit_tuple_arg</a><a href="#tymethod.emit_tuple_struct">emit_tuple_struct</a><a href="#tymethod.emit_tuple_struct_arg">emit_tuple_struct_arg</a><a href="#tymethod.emit_option">emit_option</a><a href="#tymethod.emit_option_none">emit_option_none</a><a href="#tymethod.emit_option_some">emit_option_some</a><a href="#tymethod.emit_seq">emit_seq</a><a href="#tymethod.emit_seq_elt">emit_seq_elt</a><a href="#tymethod.emit_map">emit_map</a><a href="#tymethod.emit_map_elt_key">emit_map_elt_key</a><a href="#tymethod.emit_map_elt_val">emit_map_elt_val</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: 'Encoder', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  28. </nav>
  29. <div class="theme-picker">
  30. <button id="theme-picker" aria-label="Pick another theme!">
  31. <img src="../brush.svg" width="18" alt="Pick another theme!">
  32. </button>
  33. <div id="theme-choices"></div>
  34. </div>
  35. <script src="../theme.js"></script>
  36. <nav class="sub">
  37. <form class="search-form js-only">
  38. <div class="search-container">
  39. <input class="search-input" name="search"
  40. autocomplete="off"
  41. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  42. type="search">
  43. </div>
  44. </form>
  45. </nav>
  46. <section id='main' class="content">
  47. <h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>rustc_serialize</a>::<wbr><a class="trait" href=''>Encoder</a></span><span class='out-of-band'><span id='render-detail'>
  48. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  49. [<span class='inner'>&#x2212;</span>]
  50. </a>
  51. </span><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#47-489' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust trait'>pub trait Encoder {
  53. type <a href='#associatedtype.Error' class="type">Error</a>;
  54. fn <a href='#tymethod.emit_nil' class='fnname'>emit_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.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  55. <div class='item-spacer'></div> fn <a href='#tymethod.emit_usize' class='fnname'>emit_usize</a>(&amp;mut self, v: <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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  56. <div class='item-spacer'></div> fn <a href='#tymethod.emit_u64' class='fnname'>emit_u64</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  57. <div class='item-spacer'></div> fn <a href='#tymethod.emit_u32' class='fnname'>emit_u32</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  58. <div class='item-spacer'></div> fn <a href='#tymethod.emit_u16' class='fnname'>emit_u16</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  59. <div class='item-spacer'></div> fn <a href='#tymethod.emit_u8' class='fnname'>emit_u8</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  60. <div class='item-spacer'></div> fn <a href='#tymethod.emit_isize' class='fnname'>emit_isize</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  61. <div class='item-spacer'></div> fn <a href='#tymethod.emit_i64' class='fnname'>emit_i64</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  62. <div class='item-spacer'></div> fn <a href='#tymethod.emit_i32' class='fnname'>emit_i32</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  63. <div class='item-spacer'></div> fn <a href='#tymethod.emit_i16' class='fnname'>emit_i16</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  64. <div class='item-spacer'></div> fn <a href='#tymethod.emit_i8' class='fnname'>emit_i8</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  65. <div class='item-spacer'></div> fn <a href='#tymethod.emit_bool' class='fnname'>emit_bool</a>(&amp;mut self, v: <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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  66. <div class='item-spacer'></div> fn <a href='#tymethod.emit_f64' class='fnname'>emit_f64</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  67. <div class='item-spacer'></div> fn <a href='#tymethod.emit_f32' class='fnname'>emit_f32</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  68. <div class='item-spacer'></div> fn <a href='#tymethod.emit_char' class='fnname'>emit_char</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  69. <div class='item-spacer'></div> fn <a href='#tymethod.emit_str' class='fnname'>emit_str</a>(&amp;mut self, v: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  70. <div class='item-spacer'></div> fn <a href='#tymethod.emit_enum' class='fnname'>emit_enum</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  71. <div class='item-spacer'></div> fn <a href='#tymethod.emit_enum_variant' class='fnname'>emit_enum_variant</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;v_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;v_id: <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;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  72. <div class='item-spacer'></div> fn <a href='#tymethod.emit_enum_variant_arg' class='fnname'>emit_enum_variant_arg</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  73. <div class='item-spacer'></div> fn <a href='#tymethod.emit_enum_struct_variant' class='fnname'>emit_enum_struct_variant</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;v_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;v_id: <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;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  74. <div class='item-spacer'></div> fn <a href='#tymethod.emit_enum_struct_variant_field' class='fnname'>emit_enum_struct_variant_field</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  75. <div class='item-spacer'></div> fn <a href='#tymethod.emit_struct' class='fnname'>emit_struct</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  76. <div class='item-spacer'></div> fn <a href='#tymethod.emit_struct_field' class='fnname'>emit_struct_field</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  77. <div class='item-spacer'></div> fn <a href='#tymethod.emit_tuple' class='fnname'>emit_tuple</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  78. <div class='item-spacer'></div> fn <a href='#tymethod.emit_tuple_arg' class='fnname'>emit_tuple_arg</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  79. <div class='item-spacer'></div> fn <a href='#tymethod.emit_tuple_struct' class='fnname'>emit_tuple_struct</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  80. <div class='item-spacer'></div> fn <a href='#tymethod.emit_tuple_struct_arg' class='fnname'>emit_tuple_struct_arg</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  81. <div class='item-spacer'></div> fn <a href='#tymethod.emit_option' class='fnname'>emit_option</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  82. <div class='item-spacer'></div> fn <a href='#tymethod.emit_option_none' class='fnname'>emit_option_none</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.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
  83. <div class='item-spacer'></div> fn <a href='#tymethod.emit_option_some' class='fnname'>emit_option_some</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  84. <div class='item-spacer'></div> fn <a href='#tymethod.emit_seq' class='fnname'>emit_seq</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  85. <div class='item-spacer'></div> fn <a href='#tymethod.emit_seq_elt' class='fnname'>emit_seq_elt</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  86. <div class='item-spacer'></div> fn <a href='#tymethod.emit_map' class='fnname'>emit_map</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  87. <div class='item-spacer'></div> fn <a href='#tymethod.emit_map_elt_key' class='fnname'>emit_map_elt_key</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  88. <div class='item-spacer'></div> fn <a href='#tymethod.emit_map_elt_val' class='fnname'>emit_map_elt_val</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</span>;
  89. }</pre><div class='docblock'><p>Trait for writing out an encoding when serializing.</p>
  90. <p>This trait provides methods to encode basic types and generic forms of
  91. collections. Implementations of <code>Encodable</code> use it to perform the actual
  92. encoding of a type.</p>
  93. <p>It is unspecified what is done with the encoding - it could be stored in a
  94. variable, or written directly to a file, for example.</p>
  95. <p>Encoders can expect to only have a single &quot;root&quot; method call made on this
  96. trait. Non-trivial types will call one of the collection-emitting methods,
  97. passing a function that may call other methods on the trait, but once the
  98. collection-emitting method has returned, encoding should be complete.</p>
  99. </div>
  100. <h2 id='associated-types' class='small-section-header'>
  101. Associated Types<a href='#associated-types' class='anchor'></a>
  102. </h2>
  103. <div class='methods'>
  104. <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>
  105. </div></div>
  106. <h2 id='required-methods' class='small-section-header'>
  107. Required Methods<a href='#required-methods' class='anchor'></a>
  108. </h2>
  109. <div class='methods'>
  110. <h3 id='tymethod.emit_nil' class='method'><span id='emit_nil.v' class='invisible'><code>fn <a href='#tymethod.emit_nil' class='fnname'>emit_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.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a nil value.</p>
  111. <p>For example, this might be stored as the null keyword in JSON.</p>
  112. </div><h3 id='tymethod.emit_usize' class='method'><span id='emit_usize.v' class='invisible'><code>fn <a href='#tymethod.emit_usize' class='fnname'>emit_usize</a>(&amp;mut self, v: <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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a usize value.</p>
  113. </div><h3 id='tymethod.emit_u64' class='method'><span id='emit_u64.v' class='invisible'><code>fn <a href='#tymethod.emit_u64' class='fnname'>emit_u64</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a u64 value.</p>
  114. </div><h3 id='tymethod.emit_u32' class='method'><span id='emit_u32.v' class='invisible'><code>fn <a href='#tymethod.emit_u32' class='fnname'>emit_u32</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a u32 value.</p>
  115. </div><h3 id='tymethod.emit_u16' class='method'><span id='emit_u16.v' class='invisible'><code>fn <a href='#tymethod.emit_u16' class='fnname'>emit_u16</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a u16 value.</p>
  116. </div><h3 id='tymethod.emit_u8' class='method'><span id='emit_u8.v' class='invisible'><code>fn <a href='#tymethod.emit_u8' class='fnname'>emit_u8</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a u8 value.</p>
  117. </div><h3 id='tymethod.emit_isize' class='method'><span id='emit_isize.v' class='invisible'><code>fn <a href='#tymethod.emit_isize' class='fnname'>emit_isize</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a isize value.</p>
  118. </div><h3 id='tymethod.emit_i64' class='method'><span id='emit_i64.v' class='invisible'><code>fn <a href='#tymethod.emit_i64' class='fnname'>emit_i64</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a i64 value.</p>
  119. </div><h3 id='tymethod.emit_i32' class='method'><span id='emit_i32.v' class='invisible'><code>fn <a href='#tymethod.emit_i32' class='fnname'>emit_i32</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a i32 value.</p>
  120. </div><h3 id='tymethod.emit_i16' class='method'><span id='emit_i16.v' class='invisible'><code>fn <a href='#tymethod.emit_i16' class='fnname'>emit_i16</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a i16 value.</p>
  121. </div><h3 id='tymethod.emit_i8' class='method'><span id='emit_i8.v' class='invisible'><code>fn <a href='#tymethod.emit_i8' class='fnname'>emit_i8</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i8.html">i8</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a i8 value.</p>
  122. </div><h3 id='tymethod.emit_bool' class='method'><span id='emit_bool.v' class='invisible'><code>fn <a href='#tymethod.emit_bool' class='fnname'>emit_bool</a>(&amp;mut self, v: <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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a bool value.</p>
  123. <p>For example, this might be stored as the true and false keywords in
  124. JSON.</p>
  125. </div><h3 id='tymethod.emit_f64' class='method'><span id='emit_f64.v' class='invisible'><code>fn <a href='#tymethod.emit_f64' class='fnname'>emit_f64</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a f64 value.</p>
  126. </div><h3 id='tymethod.emit_f32' class='method'><span id='emit_f32.v' class='invisible'><code>fn <a href='#tymethod.emit_f32' class='fnname'>emit_f32</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a f32 value.</p>
  127. </div><h3 id='tymethod.emit_char' class='method'><span id='emit_char.v' class='invisible'><code>fn <a href='#tymethod.emit_char' class='fnname'>emit_char</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a char value.</p>
  128. <p>Note that strings should be emitted using <code>emit_str</code>, not as a sequence
  129. of <code>emit_char</code> calls.</p>
  130. </div><h3 id='tymethod.emit_str' class='method'><span id='emit_str.v' class='invisible'><code>fn <a href='#tymethod.emit_str' class='fnname'>emit_str</a>(&amp;mut self, v: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit a string value.</p>
  131. </div><h3 id='tymethod.emit_enum' class='method'><span id='emit_enum.v' class='invisible'><code>fn <a href='#tymethod.emit_enum' class='fnname'>emit_enum</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit an enumeration value.</p>
  132. <ul>
  133. <li><code>name</code> indicates the enumeration type name.</li>
  134. <li><code>f</code> is a function that will call <code>emit_enum_variant</code> or
  135. <code>emit_enum_struct_variant</code> as appropriate to write the actual value.</li>
  136. </ul>
  137. </div><h3 id='tymethod.emit_enum_variant' class='method'><span id='emit_enum_variant.v' class='invisible'><code>fn <a href='#tymethod.emit_enum_variant' class='fnname'>emit_enum_variant</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;v_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;v_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a enumeration variant value with no or unnamed data.</p>
  138. <p>This should only be called from a function passed to <code>emit_enum</code>.
  139. Variants with named data should use <code>emit_enum_struct_variant</code>.</p>
  140. <ul>
  141. <li><code>v_name</code> is the variant name</li>
  142. <li><code>v_id</code> is the numeric identifier for the variant.</li>
  143. <li><code>len</code> is the number of data items associated with the variant.</li>
  144. <li><code>f</code> is a function that will call <code>emit_enum_variant_arg</code> for each data
  145. item. It may not be called if len is 0.</li>
  146. </ul>
  147. <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
  148. <pre class="rust rust-example-rendered">
  149. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encodable</span>;
  150. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encoder</span>;
  151. <span class="kw">enum</span> <span class="ident">Message</span> {
  152. <span class="ident">Quit</span>,
  153. <span class="ident">ChangeColor</span>(<span class="ident">i32</span>, <span class="ident">i32</span>, <span class="ident">i32</span>),
  154. }
  155. <span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="ident">Message</span> {
  156. <span class="kw">fn</span> <span class="ident">encode</span><span class="op">&lt;</span><span class="ident">S</span>: <span class="ident">Encoder</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">S</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">S</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
  157. <span class="ident">s</span>.<span class="ident">emit_enum</span>(<span class="string">&quot;Message&quot;</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  158. <span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> {
  159. <span class="ident">Message</span>::<span class="ident">Quit</span> <span class="op">=&gt;</span> {
  160. <span class="ident">s</span>.<span class="ident">emit_enum_variant</span>(<span class="string">&quot;Quit&quot;</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="prelude-val">Ok</span>(()))
  161. }
  162. <span class="ident">Message</span>::<span class="ident">ChangeColor</span>(<span class="ident">r</span>, <span class="ident">g</span>, <span class="ident">b</span>) <span class="op">=&gt;</span> {
  163. <span class="ident">s</span>.<span class="ident">emit_enum_variant</span>(<span class="string">&quot;ChangeColor&quot;</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  164. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_enum_variant_arg</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  165. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">r</span>)
  166. }));
  167. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_enum_variant_arg</span>(<span class="number">1</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  168. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">g</span>)
  169. }));
  170. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_enum_variant_arg</span>(<span class="number">2</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  171. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">b</span>)
  172. }));
  173. <span class="prelude-val">Ok</span>(())
  174. })
  175. }
  176. }
  177. })
  178. }
  179. }</pre>
  180. </div><h3 id='tymethod.emit_enum_variant_arg' class='method'><span id='emit_enum_variant_arg.v' class='invisible'><code>fn <a href='#tymethod.emit_enum_variant_arg' class='fnname'>emit_enum_variant_arg</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit an unnamed data item for an enumeration variant.</p>
  181. <p>This should only be called from a function passed to
  182. <code>emit_enum_variant</code>.</p>
  183. <ul>
  184. <li><code>a_idx</code> is the (zero-based) index of the data item.</li>
  185. <li><code>f</code> is a function that will call the appropriate emit method to encode
  186. the data object.</li>
  187. </ul>
  188. <p>Note that variant data items must be emitted in order - starting with
  189. index <code>0</code> and finishing with index <code>len-1</code>.</p>
  190. </div><h3 id='tymethod.emit_enum_struct_variant' class='method'><span id='emit_enum_struct_variant.v' class='invisible'><code>fn <a href='#tymethod.emit_enum_struct_variant' class='fnname'>emit_enum_struct_variant</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;v_name: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;v_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a enumeration variant value with no or named data.</p>
  191. <p>This should only be called from a function passed to <code>emit_enum</code>.
  192. Variants with unnamed data should use <code>emit_enum_variant</code>.</p>
  193. <ul>
  194. <li><code>v_name</code> is the variant name.</li>
  195. <li><code>v_id</code> is the numeric identifier for the variant.</li>
  196. <li><code>len</code> is the number of data items associated with the variant.</li>
  197. <li><code>f</code> is a function that will call <code>emit_enum_struct_variant_field</code> for
  198. each data item. It may not be called if <code>len</code> is <code>0</code>.</li>
  199. </ul>
  200. <h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
  201. <pre class="rust rust-example-rendered">
  202. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encodable</span>;
  203. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encoder</span>;
  204. <span class="kw">enum</span> <span class="ident">Message</span> {
  205. <span class="ident">Quit</span>,
  206. <span class="ident">Move</span> { <span class="ident">x</span>: <span class="ident">i32</span>, <span class="ident">y</span>: <span class="ident">i32</span> },
  207. }
  208. <span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="ident">Message</span> {
  209. <span class="kw">fn</span> <span class="ident">encode</span><span class="op">&lt;</span><span class="ident">S</span>: <span class="ident">Encoder</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">S</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">S</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
  210. <span class="ident">s</span>.<span class="ident">emit_enum</span>(<span class="string">&quot;Message&quot;</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  211. <span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> {
  212. <span class="ident">Message</span>::<span class="ident">Quit</span> <span class="op">=&gt;</span> {
  213. <span class="ident">s</span>.<span class="ident">emit_enum_struct_variant</span>(<span class="string">&quot;Quit&quot;</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="prelude-val">Ok</span>(()))
  214. }
  215. <span class="ident">Message</span>::<span class="ident">Move</span> { <span class="ident">x</span>: <span class="ident">x</span>, <span class="ident">y</span>: <span class="ident">y</span> } <span class="op">=&gt;</span> {
  216. <span class="ident">s</span>.<span class="ident">emit_enum_struct_variant</span>(<span class="string">&quot;Move&quot;</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  217. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_enum_struct_variant_field</span>(<span class="string">&quot;x&quot;</span>, <span class="number">0</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  218. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">x</span>)
  219. }));
  220. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_enum_struct_variant_field</span>(<span class="string">&quot;y&quot;</span>, <span class="number">1</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  221. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">y</span>)
  222. }));
  223. <span class="prelude-val">Ok</span>(())
  224. })
  225. }
  226. }
  227. })
  228. }
  229. }</pre>
  230. </div><h3 id='tymethod.emit_enum_struct_variant_field' class='method'><span id='emit_enum_struct_variant_field.v' class='invisible'><code>fn <a href='#tymethod.emit_enum_struct_variant_field' class='fnname'>emit_enum_struct_variant_field</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a named data item for an enumeration variant.</p>
  231. <p>This should only be called from a function passed to
  232. <code>emit_enum_struct_variant</code>.</p>
  233. <ul>
  234. <li><code>f_name</code> is the name of the data item field.</li>
  235. <li><code>f_idx</code> is its (zero-based) index.</li>
  236. <li><code>f</code> is a function that will call the appropriate emit method to encode
  237. the data object.</li>
  238. </ul>
  239. <p>Note that fields must be emitted in order - starting with index <code>0</code> and
  240. finishing with index <code>len-1</code>.</p>
  241. </div><h3 id='tymethod.emit_struct' class='method'><span id='emit_struct.v' class='invisible'><code>fn <a href='#tymethod.emit_struct' class='fnname'>emit_struct</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a struct value.</p>
  242. <ul>
  243. <li><code>name</code> is the name of the struct.</li>
  244. <li><code>len</code> is the number of members.</li>
  245. <li><code>f</code> is a function that calls <code>emit_struct_field</code> for each member.</li>
  246. </ul>
  247. <h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
  248. <pre class="rust rust-example-rendered">
  249. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encodable</span>;
  250. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encoder</span>;
  251. <span class="kw">struct</span> <span class="ident">Point</span> {
  252. <span class="ident">x</span>: <span class="ident">i32</span>,
  253. <span class="ident">y</span>: <span class="ident">i32</span>,
  254. }
  255. <span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="ident">Point</span> {
  256. <span class="kw">fn</span> <span class="ident">encode</span><span class="op">&lt;</span><span class="ident">S</span>: <span class="ident">Encoder</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">S</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">S</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
  257. <span class="ident">s</span>.<span class="ident">emit_struct</span>(<span class="string">&quot;Point&quot;</span>, <span class="number">2</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  258. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_struct_field</span>(<span class="string">&quot;x&quot;</span>, <span class="number">0</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  259. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="self">self</span>.<span class="ident">x</span>)
  260. }));
  261. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_struct_field</span>(<span class="string">&quot;y&quot;</span>, <span class="number">1</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  262. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="self">self</span>.<span class="ident">y</span>)
  263. }));
  264. <span class="prelude-val">Ok</span>(())
  265. })
  266. }
  267. }</pre>
  268. </div><h3 id='tymethod.emit_struct_field' class='method'><span id='emit_struct_field.v' class='invisible'><code>fn <a href='#tymethod.emit_struct_field' class='fnname'>emit_struct_field</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a field item for a struct.</p>
  269. <p>This should only be called from a function passed to <code>emit_struct</code>.</p>
  270. <ul>
  271. <li><code>f_name</code> is the name of the data item field.</li>
  272. <li><code>f_idx</code> is its (zero-based) index.</li>
  273. <li><code>f</code> is a function that will call the appropriate emit method to encode
  274. the data object.</li>
  275. </ul>
  276. <p>Note that fields must be emitted in order - starting with index <code>0</code> and
  277. finishing with index <code>len-1</code>.</p>
  278. </div><h3 id='tymethod.emit_tuple' class='method'><span id='emit_tuple.v' class='invisible'><code>fn <a href='#tymethod.emit_tuple' class='fnname'>emit_tuple</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a tuple value.</p>
  279. <ul>
  280. <li><code>len</code> is the number of items in the tuple.</li>
  281. <li><code>f</code> is a function that calls <code>emit_tuple_arg</code> for each member.</li>
  282. </ul>
  283. <p>Note that external <code>Encodable</code> implementations should not normally need
  284. to use this method directly; it is meant for the use of this module's
  285. own implementation of <code>Encodable</code> for tuples.</p>
  286. </div><h3 id='tymethod.emit_tuple_arg' class='method'><span id='emit_tuple_arg.v' class='invisible'><code>fn <a href='#tymethod.emit_tuple_arg' class='fnname'>emit_tuple_arg</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a data item for a tuple.</p>
  287. <p>This should only be called from a function passed to <code>emit_tuple</code>.</p>
  288. <ul>
  289. <li><code>idx</code> is the (zero-based) index of the data item.</li>
  290. <li><code>f</code> is a function that will call the appropriate emit method to encode
  291. the data object.</li>
  292. </ul>
  293. <p>Note that tuple items must be emitted in order - starting with index <code>0</code>
  294. and finishing with index <code>len-1</code>.</p>
  295. </div><h3 id='tymethod.emit_tuple_struct' class='method'><span id='emit_tuple_struct.v' class='invisible'><code>fn <a href='#tymethod.emit_tuple_struct' class='fnname'>emit_tuple_struct</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a tuple struct value.</p>
  296. <ul>
  297. <li><code>name</code> is the name of the tuple struct.</li>
  298. <li><code>len</code> is the number of items in the tuple struct.</li>
  299. <li><code>f</code> is a function that calls <code>emit_tuple_struct_arg</code> for each member.</li>
  300. </ul>
  301. <h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
  302. <pre class="rust rust-example-rendered">
  303. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encodable</span>;
  304. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encoder</span>;
  305. <span class="kw">struct</span> <span class="ident">Pair</span>(<span class="ident">i32</span>,<span class="ident">i32</span>);
  306. <span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="ident">Pair</span> {
  307. <span class="kw">fn</span> <span class="ident">encode</span><span class="op">&lt;</span><span class="ident">S</span>: <span class="ident">Encoder</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">S</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">S</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
  308. <span class="kw">let</span> <span class="ident">Pair</span>(<span class="ident">first</span>,<span class="ident">second</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="self">self</span>;
  309. <span class="ident">s</span>.<span class="ident">emit_tuple_struct</span>(<span class="string">&quot;Pair&quot;</span>, <span class="number">2</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  310. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_tuple_arg</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  311. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">first</span>)
  312. }));
  313. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_tuple_arg</span>(<span class="number">1</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  314. <span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="ident">second</span>)
  315. }));
  316. <span class="prelude-val">Ok</span>(())
  317. })
  318. }
  319. }</pre>
  320. </div><h3 id='tymethod.emit_tuple_struct_arg' class='method'><span id='emit_tuple_struct_arg.v' class='invisible'><code>fn <a href='#tymethod.emit_tuple_struct_arg' class='fnname'>emit_tuple_struct_arg</a>&lt;F&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a data item for a tuple struct.</p>
  321. <p>This should only be called from a function passed to
  322. <code>emit_tuple_struct</code>.</p>
  323. <ul>
  324. <li><code>f_idx</code> is the (zero-based) index of the data item.</li>
  325. <li><code>f</code> is a function that will call the appropriate emit method to encode
  326. the data object.</li>
  327. </ul>
  328. <p>Note that tuple items must be emitted in order - starting with index <code>0</code>
  329. and finishing with index <code>len-1</code>.</p>
  330. </div><h3 id='tymethod.emit_option' class='method'><span id='emit_option.v' class='invisible'><code>fn <a href='#tymethod.emit_option' class='fnname'>emit_option</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit an optional value.</p>
  331. <p><code>f</code> is a function that will call either <code>emit_option_none</code> or
  332. <code>emit_option_some</code> as appropriate.</p>
  333. <p>This method allows encoders to handle <code>Option&lt;T&gt;</code> values specially,
  334. rather than using the generic enum methods, because many encoding
  335. formats have a built-in &quot;optional&quot; concept.</p>
  336. <p>Note that external <code>Encodable</code> implementations should not normally need
  337. to use this method directly; it is meant for the use of this module's
  338. own implementation of <code>Encodable</code> for <code>Option&lt;T&gt;</code>.</p>
  339. </div><h3 id='tymethod.emit_option_none' class='method'><span id='emit_option_none.v' class='invisible'><code>fn <a href='#tymethod.emit_option_none' class='fnname'>emit_option_none</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.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></span></h3><div class='docblock'><p>Emit the <code>None</code> optional value.</p>
  340. <p>This should only be called from a function passed to <code>emit_option</code>.</p>
  341. </div><h3 id='tymethod.emit_option_some' class='method'><span id='emit_option_some.v' class='invisible'><code>fn <a href='#tymethod.emit_option_some' class='fnname'>emit_option_some</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit the <code>Some(x)</code> optional value.</p>
  342. <p><code>f</code> is a function that will call the appropriate emit method to encode
  343. the data object.</p>
  344. <p>This should only be called from a function passed to <code>emit_option</code>.</p>
  345. </div><h3 id='tymethod.emit_seq' class='method'><span id='emit_seq.v' class='invisible'><code>fn <a href='#tymethod.emit_seq' class='fnname'>emit_seq</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit a sequence of values.</p>
  346. <p>This should be used for both array-like ordered sequences and set-like
  347. unordered ones.</p>
  348. <ul>
  349. <li><code>len</code> is the number of values in the sequence.</li>
  350. <li><code>f</code> is a function that will call <code>emit_seq_elt</code> for each value in the
  351. sequence.</li>
  352. </ul>
  353. </div><h3 id='tymethod.emit_seq_elt' class='method'><span id='emit_seq_elt.v' class='invisible'><code>fn <a href='#tymethod.emit_seq_elt' class='fnname'>emit_seq_elt</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit an element in a sequence.</p>
  354. <p>This should only be called from a function passed to <code>emit_seq</code>.</p>
  355. <ul>
  356. <li><code>idx</code> is the (zero-based) index of the value in the sequence.</li>
  357. <li><code>f</code> is a function that will call the appropriate emit method to encode
  358. the data object.</li>
  359. </ul>
  360. <p>Note that sequence elements must be emitted in order - starting with
  361. index <code>0</code> and finishing with index <code>len-1</code>.</p>
  362. </div><h3 id='tymethod.emit_map' class='method'><span id='emit_map.v' class='invisible'><code>fn <a href='#tymethod.emit_map' class='fnname'>emit_map</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit an associative container (map).</p>
  363. <ul>
  364. <li><code>len</code> is the number of entries in the map.</li>
  365. <li><code>f</code> is a function that will call <code>emit_map_elt_key</code> and
  366. <code>emit_map_elt_val</code> for each entry in the map.</li>
  367. </ul>
  368. <h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
  369. <pre class="rust rust-example-rendered">
  370. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encodable</span>;
  371. <span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encoder</span>;
  372. <span class="kw">struct</span> <span class="ident">SimpleMap</span><span class="op">&lt;</span><span class="ident">K</span>,<span class="ident">V</span><span class="op">&gt;</span> {
  373. <span class="ident">entries</span>: <span class="ident">Vec</span><span class="op">&lt;</span>(<span class="ident">K</span>,<span class="ident">V</span>)<span class="op">&gt;</span>,
  374. }
  375. <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">K</span>:<span class="ident">Encodable</span>,<span class="ident">V</span>:<span class="ident">Encodable</span><span class="op">&gt;</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="ident">SimpleMap</span><span class="op">&lt;</span><span class="ident">K</span>,<span class="ident">V</span><span class="op">&gt;</span> {
  376. <span class="kw">fn</span> <span class="ident">encode</span><span class="op">&lt;</span><span class="ident">S</span>: <span class="ident">Encoder</span><span class="op">&gt;</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">s</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">S</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">S</span>::<span class="ident">Error</span><span class="op">&gt;</span> {
  377. <span class="ident">s</span>.<span class="ident">emit_map</span>(<span class="self">self</span>.<span class="ident">entries</span>.<span class="ident">len</span>(), <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
  378. <span class="kw">for</span> (<span class="ident">i</span>, <span class="ident">e</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">entries</span>.<span class="ident">iter</span>().<span class="ident">enumerate</span>() {
  379. <span class="kw">let</span> (<span class="kw-2">ref</span> <span class="ident">k</span>, <span class="kw-2">ref</span> <span class="ident">v</span>) <span class="op">=</span> <span class="kw-2">*</span><span class="ident">e</span>;
  380. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_map_elt_key</span>(<span class="ident">i</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">k</span>.<span class="ident">encode</span>(<span class="ident">s</span>)));
  381. <span class="macro">try</span><span class="macro">!</span>(<span class="ident">s</span>.<span class="ident">emit_map_elt_val</span>(<span class="ident">i</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="ident">v</span>.<span class="ident">encode</span>(<span class="ident">s</span>)));
  382. }
  383. <span class="prelude-val">Ok</span>(())
  384. })
  385. }
  386. }</pre>
  387. </div><h3 id='tymethod.emit_map_elt_key' class='method'><span id='emit_map_elt_key.v' class='invisible'><code>fn <a href='#tymethod.emit_map_elt_key' class='fnname'>emit_map_elt_key</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit the key for an entry in a map.</p>
  388. <p>This should only be called from a function passed to <code>emit_map</code>.</p>
  389. <ul>
  390. <li><code>idx</code> is the (zero-based) index of the entry in the map</li>
  391. <li><code>f</code> is a function that will call the appropriate emit method to encode
  392. the key.</li>
  393. </ul>
  394. <p>Note that map entries must be emitted in order - starting with index <code>0</code>
  395. and finishing with index <code>len-1</code> - and for each entry, the key should be
  396. emitted followed immediately by the value.</p>
  397. </div><h3 id='tymethod.emit_map_elt_val' class='method'><span id='emit_map_elt_val.v' class='invisible'><code>fn <a href='#tymethod.emit_map_elt_val' class='fnname'>emit_map_elt_val</a>&lt;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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::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;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;,&nbsp;</span></code></span></h3><div class='docblock'><p>Emit the value for an entry in a map.</p>
  398. <p>This should only be called from a function passed to <code>emit_map</code>.</p>
  399. <ul>
  400. <li><code>idx</code> is the (zero-based) index of the entry in the map</li>
  401. <li><code>f</code> is a function that will call the appropriate emit method to encode
  402. the value.</li>
  403. </ul>
  404. <p>Note that map entries must be emitted in order - starting with index <code>0</code>
  405. and finishing with index <code>len-1</code> - and for each entry, the key should be
  406. emitted followed immediately by the value.</p>
  407. </div></div>
  408. <h2 id='implementors' class='small-section-header'>
  409. Implementors<a href='#implementors' class='anchor'></a>
  410. </h2>
  411. <ul class='item-list' id='implementors-list'>
  412. <li><div class='out-of-band'><a class='srclink' href='../src/rustc_serialize/json.rs.html#622-928' title='goto source code'>[src]</a></div><code>impl&lt;'a&gt; Encoder for <a class="struct" href="../rustc_serialize/json/struct.Encoder.html" title="struct rustc_serialize::json::Encoder">Encoder</a>&lt;'a&gt;<span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../rustc_serialize/json/enum.EncoderError.html" title="enum rustc_serialize::json::EncoderError">EncoderError</a>;</span></code></li>
  413. </ul><script type="text/javascript" async
  414. src="../implementors/rustc_serialize/trait.Encoder.js">
  415. </script></section>
  416. <section id='search' class="content hidden"></section>
  417. <section class="footer"></section>
  418. <aside id="help" class="hidden">
  419. <div>
  420. <h1 class="hidden">Help</h1>
  421. <div class="shortcuts">
  422. <h2>Keyboard Shortcuts</h2>
  423. <dl>
  424. <dt><kbd>?</kbd></dt>
  425. <dd>Show this help dialog</dd>
  426. <dt><kbd>S</kbd></dt>
  427. <dd>Focus the search field</dd>
  428. <dt><kbd>↑</kbd></dt>
  429. <dd>Move up in search results</dd>
  430. <dt><kbd>↓</kbd></dt>
  431. <dd>Move down in search results</dd>
  432. <dt><kbd>↹</kbd></dt>
  433. <dd>Switch tab</dd>
  434. <dt><kbd>&#9166;</kbd></dt>
  435. <dd>Go to active search result</dd>
  436. <dt><kbd>+</kbd></dt>
  437. <dd>Expand all sections</dd>
  438. <dt><kbd>-</kbd></dt>
  439. <dd>Collapse all sections</dd>
  440. </dl>
  441. </div>
  442. <div class="infos">
  443. <h2>Search Tricks</h2>
  444. <p>
  445. Prefix searches with a type followed by a colon (e.g.
  446. <code>fn:</code>) to restrict the search to a given type.
  447. </p>
  448. <p>
  449. Accepted types are: <code>fn</code>, <code>mod</code>,
  450. <code>struct</code>, <code>enum</code>,
  451. <code>trait</code>, <code>type</code>, <code>macro</code>,
  452. and <code>const</code>.
  453. </p>
  454. <p>
  455. Search functions by type signature (e.g.
  456. <code>vec -> usize</code> or <code>* -> vec</code>)
  457. </p>
  458. </div>
  459. </div>
  460. </aside>
  461. <script>
  462. window.rootPath = "../";
  463. window.currentCrate = "rustc_serialize";
  464. </script>
  465. <script src="../main.js"></script>
  466. <script defer src="../search-index.js"></script>
  467. </body>
  468. </html>