50 lines
16 KiB
HTML
50 lines
16 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="An object-safe equivalent of Serde’s `Serialize` trait."><title>Serialize in erased_serde - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="erased_serde" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../erased_serde/index.html">erased_<wbr>serde</a><span class="version">0.4.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Serialize</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.erased_serialize" title="erased_serialize">erased_serialize</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Serialize-for-dyn+Serialize" title="Serialize">Serialize</a></li><li><a href="#impl-Serialize-for-dyn+Serialize+%2B+Send" title="Serialize">Serialize</a></li><li><a href="#impl-Serialize-for-dyn+Serialize+%2B+Send+%2B+Sync" title="Serialize">Serialize</a></li><li><a href="#impl-Serialize-for-dyn+Serialize+%2B+Sync" title="Serialize">Serialize</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate erased_<wbr>serde</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">erased_serde</a></span><h1>Trait <span class="trait">Serialize</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/erased_serde/ser.rs.html#56-61">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Serialize: Sealed {
|
||
// Required method
|
||
fn <a href="#tymethod.erased_serialize" class="fn">erased_serialize</a>(
|
||
&self,
|
||
serializer: &mut dyn <a class="trait" href="trait.Serializer.html" title="trait erased_serde::Serializer">Serializer</a>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct erased_serde::Error">Error</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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 a
|
||
<code>&dyn erased_serde::Serialize</code> or <code>Box<dyn erased_serde::Serialize></code> trait
|
||
object.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>erased_serde::{Serialize, Serializer};
|
||
<span class="kw">use </span>std::collections::BTreeMap <span class="kw">as </span>Map;
|
||
<span class="kw">use </span>std::io;
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="comment">// Construct some serializers.
|
||
</span><span class="kw">let </span>json = <span class="kw-2">&mut </span>serde_json::Serializer::new(io::stdout());
|
||
<span class="kw">let </span>cbor = <span class="kw-2">&mut </span>serde_cbor::Serializer::new(serde_cbor::ser::IoWrite::new(io::stdout()));
|
||
|
||
<span class="comment">// The values in this map are boxed trait objects. Ordinarily this would not
|
||
// be possible with serde::Serializer because of object safety, but type
|
||
// erasure makes it possible with erased_serde::Serializer.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>formats: Map<<span class="kw-2">&</span>str, Box<<span class="kw">dyn </span>Serializer>> = Map::new();
|
||
formats.insert(<span class="string">"json"</span>, Box::new(<<span class="kw">dyn </span>Serializer>::erase(json)));
|
||
formats.insert(<span class="string">"cbor"</span>, Box::new(<<span class="kw">dyn </span>Serializer>::erase(cbor)));
|
||
|
||
<span class="comment">// These are boxed trait objects as well. Same thing here - type erasure
|
||
// makes this possible.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>values: Map<<span class="kw-2">&</span>str, Box<<span class="kw">dyn </span>Serialize>> = Map::new();
|
||
values.insert(<span class="string">"vec"</span>, Box::new(<span class="macro">vec!</span>[<span class="string">"a"</span>, <span class="string">"b"</span>]));
|
||
values.insert(<span class="string">"int"</span>, Box::new(<span class="number">65536</span>));
|
||
|
||
<span class="comment">// Pick a Serializer out of the formats map.
|
||
</span><span class="kw">let </span>format = formats.get_mut(<span class="string">"json"</span>).unwrap();
|
||
|
||
<span class="comment">// Pick a Serialize out of the values map.
|
||
</span><span class="kw">let </span>value = values.get(<span class="string">"vec"</span>).unwrap();
|
||
|
||
<span class="comment">// This line prints `["a","b"]` to stdout.
|
||
</span>value.erased_serialize(format).unwrap();
|
||
}</code></pre></div>
|
||
<p>This trait is sealed and can only be implemented via a <code>serde::Serialize</code>
|
||
impl.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.erased_serialize" class="method"><a class="src rightside" href="../src/erased_serde/ser.rs.html#57">Source</a><h4 class="code-header">fn <a href="#tymethod.erased_serialize" class="fn">erased_serialize</a>(&self, serializer: &mut dyn <a class="trait" href="trait.Serializer.html" title="trait erased_serde::Serializer">Serializer</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct erased_serde::Error">Error</a>></h4></section></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Serialize-for-dyn+Serialize" class="impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#impl-Serialize-for-dyn+Serialize" class="anchor">§</a><h3 class="code-header">impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + 'erased</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.serialize" class="method trait-impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#method.serialize" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/ser/trait.Serialize.html#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> Result<S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
|
||
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></summary><div class='docblock'>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Serialize-for-dyn+Serialize+%2B+Send" class="impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#impl-Serialize-for-dyn+Serialize+%2B+Send" class="anchor">§</a><h3 class="code-header">impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'erased</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.serialize-1" class="method trait-impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#method.serialize-1" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/ser/trait.Serialize.html#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> Result<S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
|
||
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></summary><div class='docblock'>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Serialize-for-dyn+Serialize+%2B+Send+%2B+Sync" class="impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#impl-Serialize-for-dyn+Serialize+%2B+Send+%2B+Sync" class="anchor">§</a><h3 class="code-header">impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'erased</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.serialize-3" class="method trait-impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#method.serialize-3" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/ser/trait.Serialize.html#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> Result<S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
|
||
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></summary><div class='docblock'>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Serialize-for-dyn+Serialize+%2B+Sync" class="impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#impl-Serialize-for-dyn+Serialize+%2B+Sync" class="anchor">§</a><h3 class="code-header">impl<'erased> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for dyn <a class="trait" href="trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'erased</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.serialize-2" class="method trait-impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#682">Source</a><a href="#method.serialize-2" class="anchor">§</a><h4 class="code-header">fn <a href="../serde/ser/trait.Serialize.html#tymethod.serialize" class="fn">serialize</a><S>(&self, serializer: S) -> Result<S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="associatedtype" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>><div class="where">where
|
||
S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>,</div></h4></section></summary><div class='docblock'>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></div></details></div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Serialize-for-T" class="impl"><a class="src rightside" href="../src/erased_serde/ser.rs.html#224-239">Source</a><a href="#impl-Serialize-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="trait.Serialize.html" title="trait erased_serde::Serialize">Serialize</a> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>,</div></h3></section></div><script src="../trait.impl/erased_serde/ser/trait.Serialize.js" async></script></section></div></main></body></html> |