mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-11 18:17:14 +00:00
52 lines
20 KiB
HTML
52 lines
20 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Serialize` trait in crate `erased_serde`."><meta name="keywords" content="rust, rustlang, rust-lang, Serialize"><title>erased_serde::Serialize - 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="../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">☰</div><a href='../erased_serde/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Serialize</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.erased_serialize">erased_serialize</a></div><a class="sidebar-title" href="#implementors">Implementors</a><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Serialize">Serialize</a></div></div><p class='location'><a href='index.html'>erased_serde</a></p><script>window.sidebarCurrent = {name: 'Serialize', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/erased_serde/ser.rs.html#58-60' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>erased_serde</a>::<wbr><a class="trait" href=''>Serialize</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Serialize {
|
|||
|
|
fn <a href='#tymethod.erased_serialize' class='fnname'>erased_serialize</a>(&self, _: &mut dyn <a class="trait" href="../erased_serde/trait.Serializer.html" title="trait erased_serde::Serializer">Serializer</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Ok, <a class="struct" href="../erased_serde/struct.Error.html" title="struct erased_serde::Error">Error</a>>;
|
|||
|
|
}</pre></div><div class='docblock'><p>An object-safe equivalent of Serde's <code>Serialize</code> trait.</p>
|
|||
|
|
<p>Any implementation of Serde's <code>Serialize</code> converts seamlessly to an
|
|||
|
|
<code>&erased_serde::Serialize</code> or <code>Box<erased_serde::Serialize></code> trait object.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">erased_serde</span>;
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_json</span>;
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde_cbor</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">BTreeMap</span> <span class="kw">as</span> <span class="ident">Map</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">use</span> <span class="ident">erased_serde</span>::{<span class="ident">Serialize</span>, <span class="ident">Serializer</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="comment">// Construct some serializers.</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">json</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">serde_json</span>::<span class="ident">ser</span>::<span class="ident">Serializer</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">stdout</span>());
|
|||
|
|
<span class="kw">let</span> <span class="ident">cbor</span> <span class="op">=</span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">serde_cbor</span>::<span class="ident">ser</span>::<span class="ident">Serializer</span>::<span class="ident">new</span>(<span class="ident">io</span>::<span class="ident">stdout</span>());
|
|||
|
|
|
|||
|
|
<span class="comment">// The values in this map are boxed trait objects. Ordinarily this would not</span>
|
|||
|
|
<span class="comment">// be possible with serde::Serializer because of object safety, but type</span>
|
|||
|
|
<span class="comment">// erasure makes it possible with erased_serde::Serializer.</span>
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">formats</span>: <span class="ident">Map</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">Serializer</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">new</span>();
|
|||
|
|
<span class="ident">formats</span>.<span class="ident">insert</span>(<span class="string">"json"</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">Serializer</span>::<span class="ident">erase</span>(<span class="ident">json</span>)));
|
|||
|
|
<span class="ident">formats</span>.<span class="ident">insert</span>(<span class="string">"cbor"</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">Serializer</span>::<span class="ident">erase</span>(<span class="ident">cbor</span>)));
|
|||
|
|
|
|||
|
|
<span class="comment">// These are boxed trait objects as well. Same thing here - type erasure</span>
|
|||
|
|
<span class="comment">// makes this possible.</span>
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">values</span>: <span class="ident">Map</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">Serialize</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">Map</span>::<span class="ident">new</span>();
|
|||
|
|
<span class="ident">values</span>.<span class="ident">insert</span>(<span class="string">"vec"</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="string">"a"</span>, <span class="string">"b"</span>]));
|
|||
|
|
<span class="ident">values</span>.<span class="ident">insert</span>(<span class="string">"int"</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="number">65536</span>));
|
|||
|
|
|
|||
|
|
<span class="comment">// Pick a Serializer out of the formats map.</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">format</span> <span class="op">=</span> <span class="ident">formats</span>.<span class="ident">get_mut</span>(<span class="string">"json"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="comment">// Pick a Serialize out of the values map.</span>
|
|||
|
|
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">values</span>.<span class="ident">get</span>(<span class="string">"vec"</span>).<span class="ident">unwrap</span>();
|
|||
|
|
|
|||
|
|
<span class="comment">// This line prints `["a","b"]` to stdout.</span>
|
|||
|
|
<span class="ident">value</span>.<span class="ident">erased_serialize</span>(<span class="ident">format</span>).<span class="ident">unwrap</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.erased_serialize' class='method'><code id='erased_serialize.v'>fn <a href='#tymethod.erased_serialize' class='fnname'>erased_serialize</a>(&self, _: &mut dyn <a class="trait" href="../erased_serde/trait.Serializer.html" title="trait erased_serde::Serializer">Serializer</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Ok, <a class="struct" href="../erased_serde/struct.Error.html" title="struct erased_serde::Error">Error</a>></code></h3></div><span class='loading-content'>Loading content...</span><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Serialize' class='impl'><code class='in-band'>impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="../erased_serde/trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + 'erased</code><a href='#impl-Serialize' class='anchor'></a><a class='srclink' href='../src/erased_serde/macros.rs.html#96-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.serialize' class="method hidden"><code id='serialize.v'>fn <a href='../serde/ser/trait.Serialize.html#tymethod.serialize' class='fnname'>serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>, </span></code><a class='srclink' href='../src/erased_serde/macros.rs.html#97-99' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Serialize-1' class='impl'><code class='in-band'>impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="../erased_serde/trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'erased</code><a href='#impl-Serialize-1' class='anchor'></a><a class='srclink' href='../src/erased_serde/macros.rs.html#96-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.serialize-1' class="method hidden"><code id='serialize.v-1'>fn <a href='../serde/ser/trait.Serialize.html#tymethod.serialize' class='fnname'>serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>, </span></code><a class='srclink' href='../src/erased_serde/macros.rs.html#97-99' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Serialize-2' class='impl'><code class='in-band'>impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="../erased_serde/trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'erased</code><a href='#impl-Serialize-2' class='anchor'></a><a class='srclink' href='../src/erased_serde/macros.rs.html#96-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.serialize-2' class="method hidden"><code id='serialize.v-2'>fn <a href='../serde/ser/trait.Serialize.html#tymethod.serialize' class='fnname'>serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>, </span></code><a class='srclink' href='../src/erased_serde/macros.rs.html#97-99' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Serialize-3' class='impl'><code class='in-band'>impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="../erased_serde/trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'erased</code><a href='#impl-Serialize-3' class='anchor'></a><a class='srclink' href='../src/erased_serde/macros.rs.html#96-100' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.serialize-3' class="method hidden"><code id='serialize.v-3'>fn <a href='../serde/ser/trait.Serialize.html#tymethod.serialize' class='fnname'>serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>, </span></code><a class='srclink' href='../src/erased_serde/macros.rs.html#97-99' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
|
|||
|
|
</div></div></div>
|
|||
|
|
<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-Serialize-4' class='impl'><code class='in-band'>impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> Serialize for T <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code><a href='#impl-Serialize-4' class='anchor'></a><a class='srclink' href='../src/erased_serde/ser.rs.html#251-258' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.erased_serialize' class="method hidden"><code id='erased_serialize.v-1'>fn <a href='#method.erased_serialize' class='fnname'>erased_serialize</a>(&self, serializer: &mut dyn <a class="trait" href="../erased_serde/trait.Serializer.html" title="trait erased_serde::Serializer">Serializer</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Ok, <a class="struct" href="../erased_serde/struct.Error.html" title="struct erased_serde::Error">Error</a>></code><a class='srclink' href='../src/erased_serde/ser.rs.html#255-257' 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/erased_serde/trait.Serialize.js">
|
|||
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><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 = "erased_serde";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|