mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2bc9ebdc6b'
${ noResults }
Trac3r-rust/doc/rustc_serialize/trait.Encodable.html

50 lines
153 KiB
Raw Normal View History Unescape

add doc
5 years ago
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Encodable` trait in crate `rustc_serialize`."><meta name="keywords" content="rust, rustlang, rust-lang, Encodable"><title>rustc_serialize::Encodable - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../rustc_serialize/index.html'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo'></div></a><p class='location'>Trait Encodable</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.encode">encode</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Encodable-for-%26%27a%20T">&amp;&#39;a T</a><a href="#impl-Encodable-for-%5BT%3B%200%5D">[T; 0]</a><a href="#impl-Encodable-for-%5BT%3B%201%5D">[T; 1]</a><a href="#impl-Encodable-for-%5BT%3B%2010%5D">[T; 10]</a><a href="#impl-Encodable-for-%5BT%3B%2011%5D">[T; 11]</a><a href="#impl-Encodable-for-%5BT%3B%2012%5D">[T; 12]</a><a href="#impl-Encodable-for-%5BT%3B%2013%5D">[T; 13]</a><a href="#impl-Encodable-for-%5BT%3B%2014%5D">[T; 14]</a><a href="#impl-Encodable-for-%5BT%3B%2015%5D">[T; 15]</a><a href="#impl-Encodable-for-%5BT%3B%2016%5D">[T; 16]</a><a href="#impl-Encodable-for-%5BT%3B%2017%5D">[T; 17]</a><a href="#impl-Encodable-for-%5BT%3B%2018%5D">[T; 18]</a><a href="#impl-Encodable-for-%5BT%3B%2019%5D">[T; 19]</a><a href="#impl-Encodable-for-%5BT%3B%202%5D">[T; 2]</a><a href="#impl-Encodable-for-%5BT%3B%2020%5D">[T; 20]</a><a href="#impl-Encodable-for-%5BT%3B%2021%5D">[T; 21]</a><a href="#impl-Encodable-for-%5BT%3B%2022%5D">[T; 22]</a><a href="#impl-Encodable-for-%5BT%3B%2023%5D">[T; 23]</a><a href="#impl-Encodable-for-%5BT%3B%2024%5D">[T; 24]</a><a href="#impl-Encodable-for-%5BT%3B%2025%5D">[T; 25]</a><a href="#impl-Encodable-for-%5BT%3B%2026%5D">[T; 26]</a><a href="#impl-Encodable-for-%5BT%3B%2027%5D">[T; 27]</a><a href="#impl-Encodable-for-%5BT%3B%2028%5D">[T; 28]</a><a href="#impl-Encodable-for-%5BT%3B%2029%5D">[T; 29]</a><a href="#impl-Encodable-for-%5BT%3B%203%5D">[T; 3]</a><a href="#impl-Encodable-for-%5BT%3B%2030%5D">[T; 30]</a><a href="#impl-Encodable-for-%5BT%3B%2031%5D">[T; 31]</a><a href="#impl-Encodable-for-%5BT%3B%2032%5D">[T; 32]</a><a href="#impl-Encodable-for-%5BT%3B%204%5D">[T; 4]</a><a href="#impl-Encodable-for-%5BT%3B%205%5D">[T; 5]</a><a href="#impl-Encodable-for-%5BT%3B%206%5D">[T; 6]</a><a href="#impl-Encodable-for-%5BT%3B%207%5D">[T; 7]</a><a href="#impl-Encodable-for-%5BT%3B%208%5D">[T; 8]</a><a href="#impl-Encodable-for-%5BT%3B%209%5D">[T; 9]</a><a href="#impl-Encodable-for-%5BT%5D">[T]</a><a href="#impl-Encodable-for-()">()</a><a href="#impl-Encodable-for-(T0%2C%20T1%2C%20T2%2C%20T3%2C%20T4%2C%20T5%2C%20T6%2C%20T7%2C%20T8%2C%20T9%2C%20T10%2C%20T11)">(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Encodable-for-(T1%2C%20T2%2C%20T3%2C%20T4%2C%20T5%2C%20T6%2C%20T7%2C%20T8%2C%20T9%2C%20T10%2C%20T11)">(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)</a><a href="#impl-Encodable-for-(T10%2C%20T11)">(T10, T11)</a><a href="#impl-Enco
fn <a href='#tymethod.encode' class='fnname'>encode</a>&lt;S:&nbsp;<a class="trait" href="../rustc_serialize/trait.Encoder.html" title="trait rustc_serialize::Encoder">Encoder</a>&gt;(&amp;self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>S) -&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>, S::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;;
}</pre></div><div class='docblock'><p>Trait for serializing a type.</p>
<p>This can be implemented for custom data types to allow them to be encoded
with <code>Encoder</code> implementations. Most of Rust's built-in or standard data
types (like <code>i32</code> and <code>Vec&lt;T&gt;</code>) have <code>Encodable</code> implementations provided by
this module.</p>
<p>Note that, in general, you should let the compiler implement this for you by
using the <code>derive(RustcEncodable)</code> attribute.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">RustcEncodable</span>)]</span>
<span class="kw">struct</span> <span class="ident">Point</span> {
<span class="ident">x</span>: <span class="ident">i32</span>,
<span class="ident">y</span>: <span class="ident">i32</span>,
}</pre></div>
<p>This generates code equivalent to:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;
<span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encodable</span>;
<span class="kw">use</span> <span class="ident">rustc_serialize</span>::<span class="ident">Encoder</span>;
<span class="kw">struct</span> <span class="ident">Point</span> {
<span class="ident">x</span>: <span class="ident">i32</span>,
<span class="ident">y</span>: <span class="ident">i32</span>,
}
<span class="kw">impl</span> <span class="ident">Encodable</span> <span class="kw">for</span> <span class="ident">Point</span> {
<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">-</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> {
<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> {
<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> {
<span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="self">self</span>.<span class="ident">x</span>)
}));
<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> {
<span class="ident">s</span>.<span class="ident">emit_i32</span>(<span class="self">self</span>.<span class="ident">y</span>)
}));
<span class="prelude-val">Ok</span>(())
})
}
}</pre></div>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.encode' class='method'><code id='encode.v'>fn <a href='#tymethod.encode' class='fnname'>encode</a>&lt;S:&nbsp;<a class="trait" href="../rustc_serialize/trait.Encoder.html" title="trait rustc_serialize::Encoder">Encoder</a>&gt;(&amp;self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>S) -&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>, S::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code></h3><div class='docblock'><p>Serialize a value using an <code>Encoder</code>.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Encodable-for-usize' class='impl'><code class='in-band'>impl <a class="trait" href="../rustc_serialize/trait.Encodable.html" title="trait rustc_serialize::Encodable">Encodable</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-Encodable-for-usize' class='anchor'></a><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#907-911' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.encode' class="method hidden"><code id='encode.v-1'>fn <a href='#method.encode' class='fnname'>encode</a>&lt;S:&nbsp;<a class="trait" href="../rustc_serialize/trait.Encoder.html" title="trait rustc_serialize::Encoder">Encoder</a>&gt;(&amp;self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>S) -&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>, S::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#908-910' title='goto source code'>[src]</a></h4></div><h3 id='impl-Encodable-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../rustc_serialize/trait.Encodable.html" title="trait rustc_serialize::Encodable">Encodable</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-Encodable-for-u8' class='anchor'></a><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#919-923' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.encode-1' class="method hidden"><code id='encode.v-2'>fn <a href='#method.encode' class='fnname'>encode</a>&lt;S:&nbsp;<a class="trait" href="../rustc_serialize/trait.Encoder.html" title="trait rustc_serialize::Encoder">Encoder</a>&gt;(&amp;self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>S) -&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>, S::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#920-922' title='goto source code'>[src]</a></h4></div><h3 id='impl-Encodable-for-u16' class='impl'><code class='in-band'>impl <a class="trait" href="../rustc_serialize/trait.Encodable.html" title="trait rustc_serialize::Encodable">Encodable</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-Encodable-for-u16' class='anchor'></a><a class='srclink' href='../src/rustc_serialize/serialize.rs.html#931-935' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.encode-2' class="method hidden"><code id='encode.v-3'>fn <a href='#method.encode' class='fnname'>encode</a>&lt;S:&nbsp;<a class="trait" href="../rustc_serialize/trait.Encoder.html" title="trait rustc_serialize::Encoder">Encoder</a>&gt;(&amp;self, s: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>S) -&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>, S::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Encodable' class='impl'><code class='in-band'>impl Encodable for <a class="enum" href="../rustc_serialize/json/enum.Json.html" title="enum rustc_serialize::json::Json">Json</a></code><a href='#impl-Encodable' class='anchor'></a><a class='srclink' href='../src/rustc_serialize/json.rs.html#930-943' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.encode-82' class="method hidden"><code id='encode.v-83'>fn <a href='#method.encode-82' class='fnname'>encode</a>&lt;S:&nbsp;<a class="trait" href="../rustc_serialize/trait.Encoder.html" title="trait rustc_serialize::Encoder">Encoder</a>&gt;(&amp;self, e: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>S) -&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>, S::<a class="type" href="../rustc_serialize/trait.Encoder.html#associatedtype.Error" title="type rustc_serialize::Encoder::Error">Error</a>&gt;</code><a class='srclink' href='../src/rustc_serialize/json.rs.html#931-942' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../implementors/rustc_serialize/trait.Encodable.js">
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "rustc_serialize";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>