118 lines
11 KiB
HTML
118 lines
11 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="Generic data structure serialization framework."><title>serde::ser - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module ser</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde/index.html">serde</a><span class="version">1.0.228</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module ser</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#the-serialize-trait" title="The Serialize trait">The Serialize trait</a></li><li><a href="#the-serializer-trait" title="The Serializer trait">The Serializer trait</a></li><li><a href="#implementations-of-serialize-provided-by-serde" title="Implementations of Serialize provided by Serde">Implementations of Serialize provided by Serde</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate serde</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">serde</a></div><h1>Module <span>ser</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/serde_core/lib.rs.html#111">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generic data structure serialization framework.</p>
|
||
<p>The two most important traits in this module are <a href="../trait.Serialize.html" title="trait serde::Serialize"><code>Serialize</code></a> and
|
||
<a href="../trait.Serializer.html" title="trait serde::Serializer"><code>Serializer</code></a>.</p>
|
||
<ul>
|
||
<li><strong>A type that implements <code>Serialize</code> is a data structure</strong> that can be
|
||
serialized to any data format supported by Serde, and conversely</li>
|
||
<li><strong>A type that implements <code>Serializer</code> is a data format</strong> that can
|
||
serialize any data structure supported by Serde.</li>
|
||
</ul>
|
||
<h2 id="the-serialize-trait"><a class="doc-anchor" href="#the-serialize-trait">§</a>The Serialize trait</h2>
|
||
<p>Serde provides <a href="../trait.Serialize.html" title="trait serde::Serialize"><code>Serialize</code></a> implementations for many Rust primitive and
|
||
standard library types. The complete list is below. All of these can be
|
||
serialized using Serde out of the box.</p>
|
||
<p>Additionally, Serde provides a procedural macro called <a href="https://crates.io/crates/serde_derive"><code>serde_derive</code></a> to
|
||
automatically generate <a href="../trait.Serialize.html" title="trait serde::Serialize"><code>Serialize</code></a> implementations for structs and enums
|
||
in your program. See the <a href="https://serde.rs/derive.html">derive section of the manual</a> for how to use this.</p>
|
||
<p>In rare cases it may be necessary to implement <a href="../trait.Serialize.html" title="trait serde::Serialize"><code>Serialize</code></a> manually for
|
||
some type in your program. See the <a href="https://serde.rs/impl-serialize.html">Implementing <code>Serialize</code></a> section of the
|
||
manual for more about this.</p>
|
||
<p>Third-party crates may provide <a href="../trait.Serialize.html" title="trait serde::Serialize"><code>Serialize</code></a> implementations for types that
|
||
they expose. For example the <a href="https://crates.io/crates/linked-hash-map"><code>linked-hash-map</code></a> crate provides a
|
||
<a href="https://docs.rs/linked-hash-map/*/linked_hash_map/struct.LinkedHashMap.html"><code>LinkedHashMap<K, V></code></a> type that is serializable by Serde because the crate
|
||
provides an implementation of <a href="../trait.Serialize.html" title="trait serde::Serialize"><code>Serialize</code></a> for it.</p>
|
||
<h2 id="the-serializer-trait"><a class="doc-anchor" href="#the-serializer-trait">§</a>The Serializer trait</h2>
|
||
<p><a href="../trait.Serializer.html" title="trait serde::Serializer"><code>Serializer</code></a> implementations are provided by third-party crates, for
|
||
example <a href="https://github.com/serde-rs/json"><code>serde_json</code></a>, <a href="https://github.com/dtolnay/serde-yaml"><code>serde_yaml</code></a> and <a href="https://github.com/jamesmunns/postcard"><code>postcard</code></a>.</p>
|
||
<p>A partial list of well-maintained formats is given on the <a href="https://serde.rs/#data-formats">Serde
|
||
website</a>.</p>
|
||
<h2 id="implementations-of-serialize-provided-by-serde"><a class="doc-anchor" href="#implementations-of-serialize-provided-by-serde">§</a>Implementations of Serialize provided by Serde</h2>
|
||
<ul>
|
||
<li><strong>Primitive types</strong>:
|
||
<ul>
|
||
<li>bool</li>
|
||
<li>i8, i16, i32, i64, i128, isize</li>
|
||
<li>u8, u16, u32, u64, u128, usize</li>
|
||
<li>f32, f64</li>
|
||
<li>char</li>
|
||
<li>str</li>
|
||
<li>&T and &mut T</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Compound types</strong>:
|
||
<ul>
|
||
<li>[T]</li>
|
||
<li>[T; 0] through [T; 32]</li>
|
||
<li>tuples up to size 16</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Common standard library types</strong>:
|
||
<ul>
|
||
<li>String</li>
|
||
<li>Option<T></li>
|
||
<li>Result<T, E></li>
|
||
<li>PhantomData<T></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Wrapper types</strong>:
|
||
<ul>
|
||
<li>Box<T></li>
|
||
<li>Cow<’a, T></li>
|
||
<li>Cell<T></li>
|
||
<li>RefCell<T></li>
|
||
<li>Mutex<T></li>
|
||
<li>RwLock<T></li>
|
||
<li>Rc<T> <em>(if</em> features = [“rc”] <em>is enabled)</em></li>
|
||
<li>Arc<T> <em>(if</em> features = [“rc”] <em>is enabled)</em></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Collection types</strong>:
|
||
<ul>
|
||
<li>BTreeMap<K, V></li>
|
||
<li>BTreeSet<T></li>
|
||
<li>BinaryHeap<T></li>
|
||
<li>HashMap<K, V, H></li>
|
||
<li>HashSet<T, H></li>
|
||
<li>LinkedList<T></li>
|
||
<li>VecDeque<T></li>
|
||
<li>Vec<T></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>FFI types</strong>:
|
||
<ul>
|
||
<li>CStr</li>
|
||
<li>CString</li>
|
||
<li>OsStr</li>
|
||
<li>OsString</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Miscellaneous standard library types</strong>:
|
||
<ul>
|
||
<li>Duration</li>
|
||
<li>SystemTime</li>
|
||
<li>Path</li>
|
||
<li>PathBuf</li>
|
||
<li>Range<T></li>
|
||
<li>RangeInclusive<T></li>
|
||
<li>Bound<T></li>
|
||
<li>num::NonZero*</li>
|
||
<li><code>!</code> <em>(unstable)</em></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Net types</strong>:
|
||
<ul>
|
||
<li>IpAddr</li>
|
||
<li>Ipv4Addr</li>
|
||
<li>Ipv6Addr</li>
|
||
<li>SocketAddr</li>
|
||
<li>SocketAddrV4</li>
|
||
<li>SocketAddrV6</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a></dt><dd>Helper type for implementing a <code>Serializer</code> that does not support
|
||
serializing one of the compound types.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Error.html" title="trait serde::ser::Error">Error</a></dt><dd>Trait used by <code>Serialize</code> implementations to generically construct
|
||
errors belonging to the <code>Serializer</code> against which they are
|
||
currently running.</dd><dt><a class="trait" href="trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a></dt><dd>A <strong>data structure</strong> that can be serialized into any data format supported
|
||
by Serde.</dd><dt><a class="trait" href="trait.SerializeMap.html" title="trait serde::ser::SerializeMap">Serialize<wbr>Map</a></dt><dd>Returned from <code>Serializer::serialize_map</code>.</dd><dt><a class="trait" href="trait.SerializeSeq.html" title="trait serde::ser::SerializeSeq">Serialize<wbr>Seq</a></dt><dd>Returned from <code>Serializer::serialize_seq</code>.</dd><dt><a class="trait" href="trait.SerializeStruct.html" title="trait serde::ser::SerializeStruct">Serialize<wbr>Struct</a></dt><dd>Returned from <code>Serializer::serialize_struct</code>.</dd><dt><a class="trait" href="trait.SerializeStructVariant.html" title="trait serde::ser::SerializeStructVariant">Serialize<wbr>Struct<wbr>Variant</a></dt><dd>Returned from <code>Serializer::serialize_struct_variant</code>.</dd><dt><a class="trait" href="trait.SerializeTuple.html" title="trait serde::ser::SerializeTuple">Serialize<wbr>Tuple</a></dt><dd>Returned from <code>Serializer::serialize_tuple</code>.</dd><dt><a class="trait" href="trait.SerializeTupleStruct.html" title="trait serde::ser::SerializeTupleStruct">Serialize<wbr>Tuple<wbr>Struct</a></dt><dd>Returned from <code>Serializer::serialize_tuple_struct</code>.</dd><dt><a class="trait" href="trait.SerializeTupleVariant.html" title="trait serde::ser::SerializeTupleVariant">Serialize<wbr>Tuple<wbr>Variant</a></dt><dd>Returned from <code>Serializer::serialize_tuple_variant</code>.</dd><dt><a class="trait" href="trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a></dt><dd>A <strong>data format</strong> that can serialize any data structure supported by Serde.</dd><dt><a class="trait" href="trait.StdError.html" title="trait serde::ser::StdError">StdError</a></dt><dd><code>Error</code> is a trait representing the basic expectations for error values,
|
||
i.e., values of type <code>E</code> in <a href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result"><code>Result<T, E></code></a>.</dd></dl></section></div></main></body></html> |