| <!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="A data format that can serialize any data structure supported by Serde."><meta name="keywords" content="rust, rustlang, rust-lang, Serializer"><title>Serializer in serde - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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">☰</button><a class="sidebar-logo" href="../serde/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../serde/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Serializer</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error">Error</a></li><li><a href="#associatedtype.Ok">Ok</a></li><li><a href="#associatedtype.SerializeMap">SerializeMap</a></li><li><a href="#associatedtype.SerializeSeq">SerializeSeq</a></li><li><a href="#associatedtype.SerializeStruct">SerializeStruct</a></li><li><a href="#associatedtype.SerializeStructVariant">SerializeStructVariant</a></li><li><a href="#associatedtype.SerializeTuple">SerializeTuple</a></li><li><a href="#associatedtype.SerializeTupleStruct">SerializeTupleStruct</a></li><li><a href="#associatedtype.SerializeTupleVariant">SerializeTupleVariant</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.serialize_bool">serialize_bool</a></li><li><a href="#tymethod.serialize_bytes">serialize_bytes</a></li><li><a href="#tymethod.serialize_char">serialize_char</a></li><li><a href="#tymethod.serialize_f32">serialize_f32</a></li><li><a href="#tymethod.serialize_f64">serialize_f64</a></li><li><a href="#tymethod.serialize_i16">serialize_i16</a></li><li><a href="#tymethod.serialize_i32">serialize_i32</a></li><li><a href="#tymethod.serialize_i64">serialize_i64</a></li><li><a href="#tymethod.serialize_i8">serialize_i8</a></li><li><a href="#tymethod.serialize_map">serialize_map</a></li><li><a href="#tymethod.serialize_newtype_struct">serialize_newtype_struct</a></li><li><a href="#tymethod.serialize_newtype_variant">serialize_newtype_variant</a></li><li><a href="#tymethod.serialize_none">serialize_none</a></li><li><a href="#tymethod.serialize_seq">serialize_seq</a></li><li><a href="#tymethod.serialize_some">serialize_some</a></li><li><a href="#tymethod.serialize_str">serialize_str</a></li><li><a href="#tymethod.serialize_struct">serialize_struct</a></li><li><a href="#tymethod.serialize_struct_variant">serialize_struct_variant</a></li><li><a href="#tymethod.serialize_tuple">serialize_tuple</a></li><li><a href="#tymethod.serialize_tuple_struct">serialize_tuple_struct</a></li><li><a href="#tymethod.serialize_tuple_variant">serialize_tuple_variant</a></li><li><a href="#tymethod.serialize_u16">serialize_u16</a></li><li><a href="#tymethod.serialize_u32">serialize_u32</a></li><li><a href="#tymethod.serialize_u64">serialize_u64</a></li><li><a href="#tymethod.serialize_u8">serialize_u8</a></li><li><a href="#tymethod.serialize_unit">serialize_unit</a></li><li><a href="#tymethod.serialize_unit_struct">serialize_unit_struct</a></li><li><a href="#tymethod.serialize_unit_variant">serialize_unit_variant</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.collect_map">collect_map</a></li><li><a href="#method.collect_seq">collect_seq</a></li><li><a href="#method.collect_str">collect_str</a></li><li><a href="#method.is_human_readable">is_human_readable</a></li><li><a href="#method.serialize_i128">serialize_i128</a></li><li><a href="#method.serialize_u128">serialize_u128</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Serializer-for-%26%27a%20mut%20Formatter%3C%27b%3E">&'a mut Formatter<'b></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In serde</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">serde</a>::<wbr><a class="trait" href="#">Serializer</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/serde/ser/mod.rs.html#333-1474">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Serializer: Sized { |
| type <a href="#associatedtype.Ok" class="associatedtype">Ok</a>; |
| type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="ser/trait.Error.html" title="trait serde::ser::Error">Error</a>; |
| type <a href="#associatedtype.SerializeSeq" class="associatedtype">SerializeSeq</a>: <a class="trait" href="ser/trait.SerializeSeq.html" title="trait serde::ser::SerializeSeq">SerializeSeq</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| type <a href="#associatedtype.SerializeTuple" class="associatedtype">SerializeTuple</a>: <a class="trait" href="ser/trait.SerializeTuple.html" title="trait serde::ser::SerializeTuple">SerializeTuple</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| type <a href="#associatedtype.SerializeTupleStruct" class="associatedtype">SerializeTupleStruct</a>: <a class="trait" href="ser/trait.SerializeTupleStruct.html" title="trait serde::ser::SerializeTupleStruct">SerializeTupleStruct</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| type <a href="#associatedtype.SerializeTupleVariant" class="associatedtype">SerializeTupleVariant</a>: <a class="trait" href="ser/trait.SerializeTupleVariant.html" title="trait serde::ser::SerializeTupleVariant">SerializeTupleVariant</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| type <a href="#associatedtype.SerializeMap" class="associatedtype">SerializeMap</a>: <a class="trait" href="ser/trait.SerializeMap.html" title="trait serde::ser::SerializeMap">SerializeMap</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| type <a href="#associatedtype.SerializeStruct" class="associatedtype">SerializeStruct</a>: <a class="trait" href="ser/trait.SerializeStruct.html" title="trait serde::ser::SerializeStruct">SerializeStruct</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| type <a href="#associatedtype.SerializeStructVariant" class="associatedtype">SerializeStructVariant</a>: <a class="trait" href="ser/trait.SerializeStructVariant.html" title="trait serde::ser::SerializeStructVariant">SerializeStructVariant</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| |
| <details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 34 methods</span></summary> fn <a href="#tymethod.serialize_bool" class="fnname">serialize_bool</a>(self, v: bool) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_i8" class="fnname">serialize_i8</a>(self, v: i8) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_i16" class="fnname">serialize_i16</a>(self, v: i16) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_i32" class="fnname">serialize_i32</a>(self, v: i32) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_i64" class="fnname">serialize_i64</a>(self, v: i64) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_u8" class="fnname">serialize_u8</a>(self, v: u8) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_u16" class="fnname">serialize_u16</a>(self, v: u16) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_u32" class="fnname">serialize_u32</a>(self, v: u32) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_u64" class="fnname">serialize_u64</a>(self, v: u64) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_f32" class="fnname">serialize_f32</a>(self, v: f32) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_f64" class="fnname">serialize_f64</a>(self, v: f64) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_char" class="fnname">serialize_char</a>(self, v: char) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_str" class="fnname">serialize_str</a>(self, v: &str) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_bytes" class="fnname">serialize_bytes</a>(self, v: &[u8]) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_none" class="fnname">serialize_none</a>(self) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_some" class="fnname">serialize_some</a><T: ?Sized>(<br> self,<br> value: &T<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><br> <span class="where">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a></span>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_unit" class="fnname">serialize_unit</a>(self) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_unit_struct" class="fnname">serialize_unit_struct</a>(<br> self,<br> name: &'static str<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_unit_variant" class="fnname">serialize_unit_variant</a>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_newtype_struct" class="fnname">serialize_newtype_struct</a><T: ?Sized>(<br> self,<br> name: &'static str,<br> value: &T<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><br> <span class="where">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a></span>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_newtype_variant" class="fnname">serialize_newtype_variant</a><T: ?Sized>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str,<br> value: &T<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><br> <span class="where">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a></span>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_seq" class="fnname">serialize_seq</a>(<br> self,<br> len: Option<usize><br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeSeq" title="type serde::Serializer::SerializeSeq">SerializeSeq</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_tuple" class="fnname">serialize_tuple</a>(<br> self,<br> len: usize<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTuple" title="type serde::Serializer::SerializeTuple">SerializeTuple</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_tuple_struct" class="fnname">serialize_tuple_struct</a>(<br> self,<br> name: &'static str,<br> len: usize<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTupleStruct" title="type serde::Serializer::SerializeTupleStruct">SerializeTupleStruct</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_tuple_variant" class="fnname">serialize_tuple_variant</a>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str,<br> len: usize<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTupleVariant" title="type serde::Serializer::SerializeTupleVariant">SerializeTupleVariant</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_map" class="fnname">serialize_map</a>(<br> self,<br> len: Option<usize><br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeMap" title="type serde::Serializer::SerializeMap">SerializeMap</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_struct" class="fnname">serialize_struct</a>(<br> self,<br> name: &'static str,<br> len: usize<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeStruct" title="type serde::Serializer::SerializeStruct">SerializeStruct</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.serialize_struct_variant" class="fnname">serialize_struct_variant</a>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str,<br> len: usize<br> ) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeStructVariant" title="type serde::Serializer::SerializeStructVariant">SerializeStructVariant</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>>; |
| |
| fn <a href="#method.serialize_i128" class="fnname">serialize_i128</a>(self, v: i128) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.serialize_u128" class="fnname">serialize_u128</a>(self, v: u128) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.collect_seq" class="fnname">collect_seq</a><I>(self, iter: I) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><br> <span class="where">where<br> I: IntoIterator,<br> <I as IntoIterator>::Item: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.collect_map" class="fnname">collect_map</a><K, V, I>(self, iter: I) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><br> <span class="where">where<br> K: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,<br> V: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,<br> I: IntoIterator<Item = (K, V)></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.collect_str" class="fnname">collect_str</a><T: ?Sized>(self, value: &T) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><br> <span class="where">where<br> T: Display</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.is_human_readable" class="fnname">is_human_readable</a>(&self) -> bool { ... } |
| </details>}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <strong>data format</strong> that can serialize any data structure supported by Serde.</p> |
| <p>The role of this trait is to define the serialization half of the <a href="https://serde.rs/data-model.html">Serde |
| data model</a>, which is a way to categorize every Rust data structure into one |
| of 29 possible types. Each method of the <code>Serializer</code> trait corresponds to |
| one of the types of the data model.</p> |
| <p>Implementations of <code>Serialize</code> map themselves into this data model by |
| invoking exactly one of the <code>Serializer</code> methods.</p> |
| <p>The types that make up the Serde data model are:</p> |
| <ul> |
| <li><strong>14 primitive types</strong> |
| <ul> |
| <li>bool</li> |
| <li>i8, i16, i32, i64, i128</li> |
| <li>u8, u16, u32, u64, u128</li> |
| <li>f32, f64</li> |
| <li>char</li> |
| </ul> |
| </li> |
| <li><strong>string</strong> |
| <ul> |
| <li>UTF-8 bytes with a length and no null terminator.</li> |
| <li>When serializing, all strings are handled equally. When deserializing, |
| there are three flavors of strings: transient, owned, and borrowed.</li> |
| </ul> |
| </li> |
| <li><strong>byte array</strong> - [u8] |
| <ul> |
| <li>Similar to strings, during deserialization byte arrays can be |
| transient, owned, or borrowed.</li> |
| </ul> |
| </li> |
| <li><strong>option</strong> |
| <ul> |
| <li>Either none or some value.</li> |
| </ul> |
| </li> |
| <li><strong>unit</strong> |
| <ul> |
| <li>The type of <code>()</code> in Rust. It represents an anonymous value containing |
| no data.</li> |
| </ul> |
| </li> |
| <li><strong>unit_struct</strong> |
| <ul> |
| <li>For example <code>struct Unit</code> or <code>PhantomData<T></code>. It represents a named |
| value containing no data.</li> |
| </ul> |
| </li> |
| <li><strong>unit_variant</strong> |
| <ul> |
| <li>For example the <code>E::A</code> and <code>E::B</code> in <code>enum E { A, B }</code>.</li> |
| </ul> |
| </li> |
| <li><strong>newtype_struct</strong> |
| <ul> |
| <li>For example <code>struct Millimeters(u8)</code>.</li> |
| </ul> |
| </li> |
| <li><strong>newtype_variant</strong> |
| <ul> |
| <li>For example the <code>E::N</code> in <code>enum E { N(u8) }</code>.</li> |
| </ul> |
| </li> |
| <li><strong>seq</strong> |
| <ul> |
| <li>A variably sized heterogeneous sequence of values, for example |
| <code>Vec<T></code> or <code>HashSet<T></code>. When serializing, the length may or may not |
| be known before iterating through all the data. When deserializing, |
| the length is determined by looking at the serialized data.</li> |
| </ul> |
| </li> |
| <li><strong>tuple</strong> |
| <ul> |
| <li>A statically sized heterogeneous sequence of values for which the |
| length will be known at deserialization time without looking at the |
| serialized data, for example <code>(u8,)</code> or <code>(String, u64, Vec<T>)</code> or |
| <code>[u64; 10]</code>.</li> |
| </ul> |
| </li> |
| <li><strong>tuple_struct</strong> |
| <ul> |
| <li>A named tuple, for example <code>struct Rgb(u8, u8, u8)</code>.</li> |
| </ul> |
| </li> |
| <li><strong>tuple_variant</strong> |
| <ul> |
| <li>For example the <code>E::T</code> in <code>enum E { T(u8, u8) }</code>.</li> |
| </ul> |
| </li> |
| <li><strong>map</strong> |
| <ul> |
| <li>A heterogeneous key-value pairing, for example <code>BTreeMap<K, V></code>.</li> |
| </ul> |
| </li> |
| <li><strong>struct</strong> |
| <ul> |
| <li>A heterogeneous key-value pairing in which the keys are strings and |
| will be known at deserialization time without looking at the |
| serialized data, for example <code>struct S { r: u8, g: u8, b: u8 }</code>.</li> |
| </ul> |
| </li> |
| <li><strong>struct_variant</strong> |
| <ul> |
| <li>For example the <code>E::S</code> in <code>enum E { S { r: u8, g: u8, b: u8 } }</code>.</li> |
| </ul> |
| </li> |
| </ul> |
| <p>Many Serde serializers produce text or binary data as output, for example |
| JSON or Postcard. This is not a requirement of the <code>Serializer</code> trait, and |
| there are serializers that do not produce text or binary output. One example |
| is the <code>serde_json::value::Serializer</code> (distinct from the main <code>serde_json</code> |
| serializer) that produces a <code>serde_json::Value</code> data structure in memory as |
| output.</p> |
| <h2 id="example-implementation"><a href="#example-implementation">Example implementation</a></h2> |
| <p>The <a href="https://serde.rs/data-format.html">example data format</a> presented on the website contains example code for |
| a basic JSON <code>Serializer</code>.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Ok" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#342">source</a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a></h4></section></summary><div class="docblock"><p>The output type produced by this <code>Serializer</code> during successful |
| serialization. Most serializers that produce text or binary output |
| should set <code>Ok = ()</code> and serialize into an <a href="https://doc.rust-lang.org/std/io/trait.Write.html"><code>io::Write</code></a> or buffer |
| contained within the <code>Serializer</code> instance. Serializers that build |
| in-memory data structures may be simplified by using <code>Ok</code> to propagate |
| the data structure around.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Error" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#345">source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="ser/trait.Error.html" title="trait serde::ser::Error">Error</a></h4></section></summary><div class="docblock"><p>The error type when some error occurs during serialization.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeSeq" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#351">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeSeq" class="associatedtype">SerializeSeq</a>: <a class="trait" href="ser/trait.SerializeSeq.html" title="trait serde::ser::SerializeSeq">SerializeSeq</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_seq"><code>serialize_seq</code></a> for serializing the content of the |
| sequence.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeTuple" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#357">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeTuple" class="associatedtype">SerializeTuple</a>: <a class="trait" href="ser/trait.SerializeTuple.html" title="trait serde::ser::SerializeTuple">SerializeTuple</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_tuple"><code>serialize_tuple</code></a> for serializing the content of |
| the tuple.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeTupleStruct" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#363">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeTupleStruct" class="associatedtype">SerializeTupleStruct</a>: <a class="trait" href="ser/trait.SerializeTupleStruct.html" title="trait serde::ser::SerializeTupleStruct">SerializeTupleStruct</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_tuple_struct"><code>serialize_tuple_struct</code></a> for serializing the |
| content of the tuple struct.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeTupleVariant" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#369">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeTupleVariant" class="associatedtype">SerializeTupleVariant</a>: <a class="trait" href="ser/trait.SerializeTupleVariant.html" title="trait serde::ser::SerializeTupleVariant">SerializeTupleVariant</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_tuple_variant"><code>serialize_tuple_variant</code></a> for serializing the |
| content of the tuple variant.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeMap" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#375">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeMap" class="associatedtype">SerializeMap</a>: <a class="trait" href="ser/trait.SerializeMap.html" title="trait serde::ser::SerializeMap">SerializeMap</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_map"><code>serialize_map</code></a> for serializing the content of the |
| map.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeStruct" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#381">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeStruct" class="associatedtype">SerializeStruct</a>: <a class="trait" href="ser/trait.SerializeStruct.html" title="trait serde::ser::SerializeStruct">SerializeStruct</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_struct"><code>serialize_struct</code></a> for serializing the content of |
| the struct.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.SerializeStructVariant" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#387">source</a><h4 class="code-header">type <a href="#associatedtype.SerializeStructVariant" class="associatedtype">SerializeStructVariant</a>: <a class="trait" href="ser/trait.SerializeStructVariant.html" title="trait serde::ser::SerializeStructVariant">SerializeStructVariant</a><Ok = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Error = Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Type returned from <a href="#tymethod.serialize_struct_variant"><code>serialize_struct_variant</code></a> for serializing the |
| content of the struct variant.</p> |
| </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_bool" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#405">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_bool" class="fnname">serialize_bool</a>(self, v: bool) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>bool</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>bool { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_bool(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_i8" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#427">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_i8" class="fnname">serialize_i8</a>(self, v: i8) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>i8</code> value.</p> |
| <p>If the format does not differentiate between <code>i8</code> and <code>i64</code>, a |
| reasonable implementation would be to cast the value to <code>i64</code> and |
| forward to <code>serialize_i64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>i8 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_i8(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_i16" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#449">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_i16" class="fnname">serialize_i16</a>(self, v: i16) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>i16</code> value.</p> |
| <p>If the format does not differentiate between <code>i16</code> and <code>i64</code>, a |
| reasonable implementation would be to cast the value to <code>i64</code> and |
| forward to <code>serialize_i64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>i16 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_i16(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_i32" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#471">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_i32" class="fnname">serialize_i32</a>(self, v: i32) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>i32</code> value.</p> |
| <p>If the format does not differentiate between <code>i32</code> and <code>i64</code>, a |
| reasonable implementation would be to cast the value to <code>i64</code> and |
| forward to <code>serialize_i64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>i32 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_i32(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_i64" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#489">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_i64" class="fnname">serialize_i64</a>(self, v: i64) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>i64</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>i64 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_i64(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_u8" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#537">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_u8" class="fnname">serialize_u8</a>(self, v: u8) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>u8</code> value.</p> |
| <p>If the format does not differentiate between <code>u8</code> and <code>u64</code>, a |
| reasonable implementation would be to cast the value to <code>u64</code> and |
| forward to <code>serialize_u64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>u8 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_u8(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_u16" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#559">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_u16" class="fnname">serialize_u16</a>(self, v: u16) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>u16</code> value.</p> |
| <p>If the format does not differentiate between <code>u16</code> and <code>u64</code>, a |
| reasonable implementation would be to cast the value to <code>u64</code> and |
| forward to <code>serialize_u64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>u16 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_u16(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_u32" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#581">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_u32" class="fnname">serialize_u32</a>(self, v: u32) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>u32</code> value.</p> |
| <p>If the format does not differentiate between <code>u32</code> and <code>u64</code>, a |
| reasonable implementation would be to cast the value to <code>u64</code> and |
| forward to <code>serialize_u64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>u32 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_u32(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_u64" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#599">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_u64" class="fnname">serialize_u64</a>(self, v: u64) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>u64</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>u64 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_u64(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_f32" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#647">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_f32" class="fnname">serialize_f32</a>(self, v: f32) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>f32</code> value.</p> |
| <p>If the format does not differentiate between <code>f32</code> and <code>f64</code>, a |
| reasonable implementation would be to cast the value to <code>f64</code> and |
| forward to <code>serialize_f64</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>f32 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_f32(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_f64" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#665">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_f64" class="fnname">serialize_f64</a>(self, v: f64) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>f64</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>f64 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_f64(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_char" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#686">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_char" class="fnname">serialize_char</a>(self, v: char) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a character.</p> |
| <p>If the format does not support characters, it is reasonable to serialize |
| it as a single element <code>str</code> or a <code>u32</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>char { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_char(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_str" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#704">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_str" class="fnname">serialize_str</a>(self, v: &str) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>&str</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>str { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_str(<span class="self">self</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_bytes" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#739">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_bytes" class="fnname">serialize_bytes</a>(self, v: &[u8]) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a chunk of raw byte data.</p> |
| <p>Enables serializers to serialize byte slices more compactly or more |
| efficiently than other types of slices. If no efficient implementation |
| is available, a reasonable implementation would be to forward to |
| <code>serialize_seq</code>. If forwarded, the implementation looks usually just |
| like this:</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>serialize_bytes(<span class="self">self</span>, v: <span class="kw-2">&</span>[u8]) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>::Ok, <span class="self">Self</span>::Error> { |
| <span class="kw">let </span><span class="kw-2">mut </span>seq = <span class="self">self</span>.serialize_seq(<span class="prelude-val">Some</span>(v.len()))<span class="question-mark">?</span>; |
| <span class="kw">for </span>b <span class="kw">in </span>v { |
| seq.serialize_element(b)<span class="question-mark">?</span>; |
| } |
| seq.end() |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_none" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#772">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_none" class="fnname">serialize_none</a>(self) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <a href="https://doc.rust-lang.org/std/option/enum.Option.html#variant.None"><code>None</code></a> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl</span><T> Serialize <span class="kw">for </span><span class="prelude-ty">Option</span><T> |
| <span class="kw">where |
| </span>T: Serialize, |
| { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| <span class="prelude-val">Some</span>(<span class="kw-2">ref </span>value) => serializer.serialize_some(value), |
| <span class="prelude-val">None </span>=> serializer.serialize_none(), |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_some" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#805-807">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_some" class="fnname">serialize_some</a><T: ?Sized>(self, value: &T) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section></summary><div class="docblock"><p>Serialize a <a href="https://doc.rust-lang.org/std/option/enum.Option.html#variant.Some"><code>Some(T)</code></a> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl</span><T> Serialize <span class="kw">for </span><span class="prelude-ty">Option</span><T> |
| <span class="kw">where |
| </span>T: Serialize, |
| { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| <span class="prelude-val">Some</span>(<span class="kw-2">ref </span>value) => serializer.serialize_some(value), |
| <span class="prelude-val">None </span>=> serializer.serialize_none(), |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_unit" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#825">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_unit" class="fnname">serialize_unit</a>(self) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>()</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>() { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_unit() |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_unit_struct" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#845">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_unit_struct" class="fnname">serialize_unit_struct</a>(<br> self,<br> name: &'static str<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a unit struct like <code>struct Unit</code> or <code>PhantomData<T></code>.</p> |
| <p>A reasonable implementation would be to forward to <code>serialize_unit</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">struct </span>Nothing; |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>Nothing { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_unit_struct(<span class="string">"Nothing"</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_unit_variant" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#873-878">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_unit_variant" class="fnname">serialize_unit_variant</a>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a unit variant like <code>E::A</code> in <code>enum E { A, B }</code>.</p> |
| <p>The <code>name</code> is the name of the enum, the <code>variant_index</code> is the index of |
| this variant within the enum, and the <code>variant</code> is the name of the |
| variant.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">enum </span>E { |
| A, |
| B, |
| } |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>E { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| E::A => serializer.serialize_unit_variant(<span class="string">"E"</span>, <span class="number">0</span>, <span class="string">"A"</span>), |
| E::B => serializer.serialize_unit_variant(<span class="string">"E"</span>, <span class="number">1</span>, <span class="string">"B"</span>), |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_newtype_struct" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#900-906">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_newtype_struct" class="fnname">serialize_newtype_struct</a><T: ?Sized>(<br> self,<br> name: &'static str,<br> value: &T<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section></summary><div class="docblock"><p>Serialize a newtype struct like <code>struct Millimeters(u8)</code>.</p> |
| <p>Serializers are encouraged to treat newtype structs as insignificant |
| wrappers around the data they contain. A reasonable implementation would |
| be to forward to <code>value.serialize(self)</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">struct </span>Millimeters(u8); |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>Millimeters { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_newtype_struct(<span class="string">"Millimeters"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_newtype_variant" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#934-942">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_newtype_variant" class="fnname">serialize_newtype_variant</a><T: ?Sized>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str,<br> value: &T<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section></summary><div class="docblock"><p>Serialize a newtype variant like <code>E::N</code> in <code>enum E { N(u8) }</code>.</p> |
| <p>The <code>name</code> is the name of the enum, the <code>variant_index</code> is the index of |
| this variant within the enum, and the <code>variant</code> is the name of the |
| variant. The <code>value</code> is the data contained within this newtype variant.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">enum </span>E { |
| M(String), |
| N(u8), |
| } |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>E { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| E::M(<span class="kw-2">ref </span>s) => serializer.serialize_newtype_variant(<span class="string">"E"</span>, <span class="number">0</span>, <span class="string">"M"</span>, s), |
| E::N(n) => serializer.serialize_newtype_variant(<span class="string">"E"</span>, <span class="number">1</span>, <span class="string">"N"</span>, <span class="kw-2">&</span>n), |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_seq" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#990">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_seq" class="fnname">serialize_seq</a>(<br> self,<br> len: Option<usize><br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeSeq" title="type serde::Serializer::SerializeSeq">SerializeSeq</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a variably sized sequence. This call must be |
| followed by zero or more calls to <code>serialize_element</code>, then a call to |
| <code>end</code>.</p> |
| <p>The argument is the number of elements in the sequence, which may or may |
| not be computable before the sequence is iterated. Some serializers only |
| support sequences whose length is known up front.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, Serializer, SerializeSeq}; |
| |
| <span class="kw">impl</span><T> Serialize <span class="kw">for </span>Vec<T> |
| <span class="kw">where |
| </span>T: Serialize, |
| { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>seq = serializer.serialize_seq(<span class="prelude-val">Some</span>(<span class="self">self</span>.len()))<span class="question-mark">?</span>; |
| <span class="kw">for </span>element <span class="kw">in </span><span class="self">self </span>{ |
| seq.serialize_element(element)<span class="question-mark">?</span>; |
| } |
| seq.end() |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_tuple" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1046">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_tuple" class="fnname">serialize_tuple</a>(self, len: usize) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTuple" title="type serde::Serializer::SerializeTuple">SerializeTuple</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a statically sized sequence whose length will be |
| known at deserialization time without looking at the serialized data. |
| This call must be followed by zero or more calls to <code>serialize_element</code>, |
| then a call to <code>end</code>.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, Serializer, SerializeTuple}; |
| |
| <span class="kw">impl</span><A, B, C> Serialize <span class="kw">for </span>(A, B, C) |
| <span class="kw">where |
| </span>A: Serialize, |
| B: Serialize, |
| C: Serialize, |
| { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>tup = serializer.serialize_tuple(<span class="number">3</span>)<span class="question-mark">?</span>; |
| tup.serialize_element(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>)<span class="question-mark">?</span>; |
| tup.serialize_element(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">1</span>)<span class="question-mark">?</span>; |
| tup.serialize_element(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">2</span>)<span class="question-mark">?</span>; |
| tup.end() |
| } |
| }</code></pre></div> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, SerializeTuple, Serializer}; |
| |
| <span class="kw">const </span>VRAM_SIZE: usize = <span class="number">386</span>; |
| <span class="kw">struct </span>Vram([u16; VRAM_SIZE]); |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>Vram { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>seq = serializer.serialize_tuple(VRAM_SIZE)<span class="question-mark">?</span>; |
| <span class="kw">for </span>element <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>[..] { |
| seq.serialize_element(element)<span class="question-mark">?</span>; |
| } |
| seq.end() |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_tuple_struct" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1073-1077">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_tuple_struct" class="fnname">serialize_tuple_struct</a>(<br> self,<br> name: &'static str,<br> len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTupleStruct" title="type serde::Serializer::SerializeTupleStruct">SerializeTupleStruct</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a tuple struct like <code>struct Rgb(u8, u8, u8)</code>. This |
| call must be followed by zero or more calls to <code>serialize_field</code>, then a |
| call to <code>end</code>.</p> |
| <p>The <code>name</code> is the name of the tuple struct and the <code>len</code> is the number |
| of data fields that will be serialized.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, SerializeTupleStruct, Serializer}; |
| |
| <span class="kw">struct </span>Rgb(u8, u8, u8); |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>Rgb { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>ts = serializer.serialize_tuple_struct(<span class="string">"Rgb"</span>, <span class="number">3</span>)<span class="question-mark">?</span>; |
| ts.serialize_field(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>)<span class="question-mark">?</span>; |
| ts.serialize_field(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">1</span>)<span class="question-mark">?</span>; |
| ts.serialize_field(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">2</span>)<span class="question-mark">?</span>; |
| ts.end() |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_tuple_variant" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1118-1124">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_tuple_variant" class="fnname">serialize_tuple_variant</a>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str,<br> len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTupleVariant" title="type serde::Serializer::SerializeTupleVariant">SerializeTupleVariant</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a tuple variant like <code>E::T</code> in <code>enum E { T(u8, u8) }</code>. This call must be followed by zero or more calls to |
| <code>serialize_field</code>, then a call to <code>end</code>.</p> |
| <p>The <code>name</code> is the name of the enum, the <code>variant_index</code> is the index of |
| this variant within the enum, the <code>variant</code> is the name of the variant, |
| and the <code>len</code> is the number of data fields that will be serialized.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, SerializeTupleVariant, Serializer}; |
| |
| <span class="kw">enum </span>E { |
| T(u8, u8), |
| U(String, u32, u32), |
| } |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>E { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| E::T(<span class="kw-2">ref </span>a, <span class="kw-2">ref </span>b) => { |
| <span class="kw">let </span><span class="kw-2">mut </span>tv = serializer.serialize_tuple_variant(<span class="string">"E"</span>, <span class="number">0</span>, <span class="string">"T"</span>, <span class="number">2</span>)<span class="question-mark">?</span>; |
| tv.serialize_field(a)<span class="question-mark">?</span>; |
| tv.serialize_field(b)<span class="question-mark">?</span>; |
| tv.end() |
| } |
| E::U(<span class="kw-2">ref </span>a, <span class="kw-2">ref </span>b, <span class="kw-2">ref </span>c) => { |
| <span class="kw">let </span><span class="kw-2">mut </span>tv = serializer.serialize_tuple_variant(<span class="string">"E"</span>, <span class="number">1</span>, <span class="string">"U"</span>, <span class="number">3</span>)<span class="question-mark">?</span>; |
| tv.serialize_field(a)<span class="question-mark">?</span>; |
| tv.serialize_field(b)<span class="question-mark">?</span>; |
| tv.serialize_field(c)<span class="question-mark">?</span>; |
| tv.end() |
| } |
| } |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_map" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1172">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_map" class="fnname">serialize_map</a>(<br> self,<br> len: Option<usize><br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeMap" title="type serde::Serializer::SerializeMap">SerializeMap</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a map. This call must be followed by zero or more |
| calls to <code>serialize_key</code> and <code>serialize_value</code>, then a call to <code>end</code>.</p> |
| <p>The argument is the number of elements in the map, which may or may not |
| be computable before the map is iterated. Some serializers only support |
| maps whose length is known up front.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, Serializer, SerializeMap}; |
| |
| <span class="kw">impl</span><K, V> Serialize <span class="kw">for </span>HashMap<K, V> |
| <span class="kw">where |
| </span>K: Serialize, |
| V: Serialize, |
| { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>map = serializer.serialize_map(<span class="prelude-val">Some</span>(<span class="self">self</span>.len()))<span class="question-mark">?</span>; |
| <span class="kw">for </span>(k, v) <span class="kw">in </span><span class="self">self </span>{ |
| map.serialize_entry(k, v)<span class="question-mark">?</span>; |
| } |
| map.end() |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_struct" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1203-1207">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_struct" class="fnname">serialize_struct</a>(<br> self,<br> name: &'static str,<br> len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeStruct" title="type serde::Serializer::SerializeStruct">SerializeStruct</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a struct like <code>struct Rgb { r: u8, g: u8, b: u8 }</code>. |
| This call must be followed by zero or more calls to <code>serialize_field</code>, |
| then a call to <code>end</code>.</p> |
| <p>The <code>name</code> is the name of the struct and the <code>len</code> is the number of |
| data fields that will be serialized.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, SerializeStruct, Serializer}; |
| |
| <span class="kw">struct </span>Rgb { |
| r: u8, |
| g: u8, |
| b: u8, |
| } |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>Rgb { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>rgb = serializer.serialize_struct(<span class="string">"Rgb"</span>, <span class="number">3</span>)<span class="question-mark">?</span>; |
| rgb.serialize_field(<span class="string">"r"</span>, <span class="kw-2">&</span><span class="self">self</span>.r)<span class="question-mark">?</span>; |
| rgb.serialize_field(<span class="string">"g"</span>, <span class="kw-2">&</span><span class="self">self</span>.g)<span class="question-mark">?</span>; |
| rgb.serialize_field(<span class="string">"b"</span>, <span class="kw-2">&</span><span class="self">self</span>.b)<span class="question-mark">?</span>; |
| rgb.end() |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.serialize_struct_variant" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1245-1251">source</a><h4 class="code-header">fn <a href="#tymethod.serialize_struct_variant" class="fnname">serialize_struct_variant</a>(<br> self,<br> name: &'static str,<br> variant_index: u32,<br> variant: &'static str,<br> len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeStructVariant" title="type serde::Serializer::SerializeStructVariant">SerializeStructVariant</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Begin to serialize a struct variant like <code>E::S</code> in <code>enum E { S { r: u8, g: u8, b: u8 } }</code>. This call must be followed by zero or more calls to |
| <code>serialize_field</code>, then a call to <code>end</code>.</p> |
| <p>The <code>name</code> is the name of the enum, the <code>variant_index</code> is the index of |
| this variant within the enum, the <code>variant</code> is the name of the variant, |
| and the <code>len</code> is the number of data fields that will be serialized.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::ser::{Serialize, SerializeStructVariant, Serializer}; |
| |
| <span class="kw">enum </span>E { |
| S { r: u8, g: u8, b: u8 }, |
| } |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>E { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{ |
| E::S { |
| <span class="kw-2">ref </span>r, |
| <span class="kw-2">ref </span>g, |
| <span class="kw-2">ref </span>b, |
| } => { |
| <span class="kw">let </span><span class="kw-2">mut </span>sv = serializer.serialize_struct_variant(<span class="string">"E"</span>, <span class="number">0</span>, <span class="string">"S"</span>, <span class="number">3</span>)<span class="question-mark">?</span>; |
| sv.serialize_field(<span class="string">"r"</span>, r)<span class="question-mark">?</span>; |
| sv.serialize_field(<span class="string">"g"</span>, g)<span class="question-mark">?</span>; |
| sv.serialize_field(<span class="string">"b"</span>, b)<span class="question-mark">?</span>; |
| sv.end() |
| } |
| } |
| } |
| }</code></pre></div> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.serialize_i128" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#511-514">source</a><h4 class="code-header">fn <a href="#method.serialize_i128" class="fnname">serialize_i128</a>(self, v: i128) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize an <code>i128</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>i128 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_i128(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| <p>This method is available only on Rust compiler versions >=1.26. The |
| default behavior unconditionally returns an error.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.serialize_u128" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#621-624">source</a><h4 class="code-header">fn <a href="#method.serialize_u128" class="fnname">serialize_u128</a>(self, v: u128) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>></h4></section></summary><div class="docblock"><p>Serialize a <code>u128</code> value.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">impl </span>Serialize <span class="kw">for </span>u128 { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.serialize_u128(<span class="kw-2">*</span><span class="self">self</span>) |
| } |
| }</code></pre></div> |
| <p>This method is available only on Rust compiler versions >=1.26. The |
| default behavior unconditionally returns an error.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.collect_seq" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1277-1299">source</a><h4 class="code-header">fn <a href="#method.collect_seq" class="fnname">collect_seq</a><I>(self, iter: I) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> I: IntoIterator,<br> <I as IntoIterator>::Item: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section></summary><div class="docblock"><p>Collect an iterator as a sequence.</p> |
| <p>The default implementation serializes each item yielded by the iterator |
| using <a href="#tymethod.serialize_seq"><code>serialize_seq</code></a>. Implementors should not need to override this |
| method.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">struct </span>SecretlyOneHigher { |
| data: Vec<i32>, |
| } |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>SecretlyOneHigher { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.collect_seq(<span class="self">self</span>.data.iter().map(|x| x + <span class="number">1</span>)) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.collect_map" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1327-1350">source</a><h4 class="code-header">fn <a href="#method.collect_map" class="fnname">collect_map</a><K, V, I>(self, iter: I) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> K: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,<br> V: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,<br> I: IntoIterator<Item = (K, V)>,</span></h4></section></summary><div class="docblock"><p>Collect an iterator as a map.</p> |
| <p>The default implementation serializes each pair yielded by the iterator |
| using <a href="#tymethod.serialize_map"><code>serialize_map</code></a>. Implementors should not need to override this |
| method.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| <span class="kw">use </span>std::collections::BTreeSet; |
| |
| <span class="kw">struct </span>MapToUnit { |
| keys: BTreeSet<i32>, |
| } |
| |
| <span class="comment">// Serializes as a map in which the values are all unit. |
| </span><span class="kw">impl </span>Serialize <span class="kw">for </span>MapToUnit { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.collect_map(<span class="self">self</span>.keys.iter().map(|k| (k, ()))) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.collect_str" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1383-1388">source</a><h4 class="code-header">fn <a href="#method.collect_str" class="fnname">collect_str</a><T: ?Sized>(self, value: &T) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Ok" title="type serde::Serializer::Ok">Ok</a>, Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.Error" title="type serde::Serializer::Error">Error</a>><span class="where fmt-newline">where<br> T: Display,</span></h4></section></summary><div class="docblock"><p>Serialize a string produced by an implementation of <code>Display</code>.</p> |
| <p>The default implementation builds a heap-allocated <a href="https://doc.rust-lang.org/std/string/struct.String.html"><code>String</code></a> and |
| delegates to <a href="#tymethod.serialize_str"><code>serialize_str</code></a>. Serializers are encouraged to provide a |
| more efficient implementation if possible.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>DateTime { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| serializer.collect_str(<span class="kw-2">&</span><span class="macro">format_args!</span>(<span class="string">"{:?}{:?}"</span>, |
| <span class="self">self</span>.naive_local(), |
| <span class="self">self</span>.offset())) |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_human_readable" class="method has-srclink"><a class="srclink rightside" href="../src/serde/ser/mod.rs.html#1471-1473">source</a><h4 class="code-header">fn <a href="#method.is_human_readable" class="fnname">is_human_readable</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Determine whether <code>Serialize</code> implementations should serialize in |
| human-readable form.</p> |
| <p>Some types have a human-readable form that may be somewhat expensive to |
| construct, as well as a binary form that is compact and efficient. |
| Generally text-based formats like JSON and YAML will prefer to use the |
| human-readable one and binary formats like Postcard will prefer the |
| compact one.</p> |
| |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::{Serialize, Serializer}; |
| |
| <span class="kw">impl </span>Serialize <span class="kw">for </span>Timestamp { |
| <span class="kw">fn </span>serialize<S>(<span class="kw-2">&</span><span class="self">self</span>, serializer: S) -> <span class="prelude-ty">Result</span><S::Ok, S::Error> |
| <span class="kw">where |
| </span>S: Serializer, |
| { |
| <span class="kw">if </span>serializer.is_human_readable() { |
| <span class="comment">// Serialize to a human-readable string "2015-05-15T17:01:00Z". |
| </span><span class="self">self</span>.to_string().serialize(serializer) |
| } <span class="kw">else </span>{ |
| <span class="comment">// Serialize to a compact binary representation. |
| </span><span class="self">self</span>.seconds_since_epoch().serialize(serializer) |
| } |
| } |
| }</code></pre></div> |
| <p>The default implementation of this method returns <code>true</code>. Data formats |
| may override this to <code>false</code> to request a compact form for types that |
| support one. Note that modifying this method to change a format from |
| human-readable to compact or vice versa should be regarded as a breaking |
| change, as a value serialized in human-readable mode is not required to |
| deserialize from the same data in compact mode.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Serializer-for-%26%27a%20mut%20Formatter%3C%27b%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#37-174">source</a><a href="#impl-Serializer-for-%26%27a%20mut%20Formatter%3C%27b%3E" class="anchor"></a><h3 class="code-header">impl<'a, 'b> <a class="trait" href="trait.Serializer.html" title="trait serde::Serializer">Serializer</a> for &'a mut Formatter<'b></h3></section></summary><div class="docblock"> |
| <div class="example-wrap edition"><div class='tooltip' data-edition="2018">ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::Serialize; |
| <span class="kw">use </span>std::fmt::{<span class="self">self</span>, Display}; |
| |
| <span class="attribute">#[derive(Serialize)] |
| #[serde(rename_all = <span class="string">"kebab-case"</span>)] |
| </span><span class="kw">pub enum </span>MessageType { |
| StartRequest, |
| EndRequest, |
| } |
| |
| <span class="kw">impl </span>Display <span class="kw">for </span>MessageType { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="self">self</span>.serialize(f) |
| } |
| }</code></pre></div> |
| </div><div class="impl-items"><section id="associatedtype.Ok-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Ok-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Ok" class="associatedtype">Ok</a> = ()</h4></section><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = Error</h4></section><section id="associatedtype.SerializeSeq-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeSeq-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeSeq" class="associatedtype">SerializeSeq</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="associatedtype.SerializeTuple-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeTuple-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeTuple" class="associatedtype">SerializeTuple</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="associatedtype.SerializeTupleStruct-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeTupleStruct-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeTupleStruct" class="associatedtype">SerializeTupleStruct</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="associatedtype.SerializeTupleVariant-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeTupleVariant-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeTupleVariant" class="associatedtype">SerializeTupleVariant</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="associatedtype.SerializeMap-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeMap-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeMap" class="associatedtype">SerializeMap</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="associatedtype.SerializeStruct-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeStruct-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeStruct" class="associatedtype">SerializeStruct</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="associatedtype.SerializeStructVariant-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.SerializeStructVariant-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.SerializeStructVariant" class="associatedtype">SerializeStructVariant</a> = <a class="struct" href="ser/struct.Impossible.html" title="struct serde::ser::Impossible">Impossible</a><(), Error></h4></section><section id="method.serialize_bool" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_bool" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_bool" class="fnname">serialize_bool</a>(self, v: bool) -> Result</h4></section><section id="method.serialize_i8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_i8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_i8" class="fnname">serialize_i8</a>(self, v: i8) -> Result</h4></section><section id="method.serialize_i16" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_i16" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_i16" class="fnname">serialize_i16</a>(self, v: i16) -> Result</h4></section><section id="method.serialize_i32" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_i32" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_i32" class="fnname">serialize_i32</a>(self, v: i32) -> Result</h4></section><section id="method.serialize_i64" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_i64" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_i64" class="fnname">serialize_i64</a>(self, v: i64) -> Result</h4></section><section id="method.serialize_u8" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_u8" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_u8" class="fnname">serialize_u8</a>(self, v: u8) -> Result</h4></section><section id="method.serialize_u16" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_u16" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_u16" class="fnname">serialize_u16</a>(self, v: u16) -> Result</h4></section><section id="method.serialize_u32" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_u32" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_u32" class="fnname">serialize_u32</a>(self, v: u32) -> Result</h4></section><section id="method.serialize_u64" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_u64" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_u64" class="fnname">serialize_u64</a>(self, v: u64) -> Result</h4></section><section id="method.serialize_f32" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_f32" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_f32" class="fnname">serialize_f32</a>(self, v: f32) -> Result</h4></section><section id="method.serialize_f64" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_f64" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_f64" class="fnname">serialize_f64</a>(self, v: f64) -> Result</h4></section><section id="method.serialize_char" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_char" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_char" class="fnname">serialize_char</a>(self, v: char) -> Result</h4></section><section id="method.serialize_str" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_str" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_str" class="fnname">serialize_str</a>(self, v: &str) -> Result</h4></section><section id="method.serialize_unit_struct" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#48-63">source</a><a href="#method.serialize_unit_struct" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_unit_struct" class="fnname">serialize_unit_struct</a>(self, v: &'static str) -> Result</h4></section><section id="method.serialize_i128-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#66-69">source</a><a href="#method.serialize_i128-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.serialize_i128" class="fnname">serialize_i128</a>(self, v: i128) -> Result</h4></section><section id="method.serialize_u128-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#66-69">source</a><a href="#method.serialize_u128-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.serialize_u128" class="fnname">serialize_u128</a>(self, v: u128) -> Result</h4></section><section id="method.serialize_unit_variant" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#72-79">source</a><a href="#method.serialize_unit_variant" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_unit_variant" class="fnname">serialize_unit_variant</a>(<br> self,<br> _name: &'static str,<br> _variant_index: u32,<br> variant: &'static str<br>) -> Result</h4></section><section id="method.serialize_newtype_struct" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#81-86">source</a><a href="#method.serialize_newtype_struct" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_newtype_struct" class="fnname">serialize_newtype_struct</a><T: ?Sized>(<br> self,<br> _name: &'static str,<br> value: &T<br>) -> Result<span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section><section id="method.serialize_bytes" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#88-90">source</a><a href="#method.serialize_bytes" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_bytes" class="fnname">serialize_bytes</a>(self, _v: &[u8]) -> Result</h4></section><section id="method.serialize_none" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#92-94">source</a><a href="#method.serialize_none" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_none" class="fnname">serialize_none</a>(self) -> Result</h4></section><section id="method.serialize_some" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#96-101">source</a><a href="#method.serialize_some" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_some" class="fnname">serialize_some</a><T: ?Sized>(self, _value: &T) -> Result<span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section><section id="method.serialize_unit" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#103-105">source</a><a href="#method.serialize_unit" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_unit" class="fnname">serialize_unit</a>(self) -> Result</h4></section><section id="method.serialize_newtype_variant" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#107-118">source</a><a href="#method.serialize_newtype_variant" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_newtype_variant" class="fnname">serialize_newtype_variant</a><T: ?Sized>(<br> self,<br> _name: &'static str,<br> _variant_index: u32,<br> _variant: &'static str,<br> _value: &T<br>) -> Result<span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Serialize.html" title="trait serde::Serialize">Serialize</a>,</span></h4></section><section id="method.serialize_seq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#120-122">source</a><a href="#method.serialize_seq" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_seq" class="fnname">serialize_seq</a>(self, _len: Option<usize>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeSeq" title="type serde::Serializer::SerializeSeq">SerializeSeq</a>, Error></h4></section><section id="method.serialize_tuple" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#124-126">source</a><a href="#method.serialize_tuple" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_tuple" class="fnname">serialize_tuple</a>(self, _len: usize) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTuple" title="type serde::Serializer::SerializeTuple">SerializeTuple</a>, Error></h4></section><section id="method.serialize_tuple_struct" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#128-134">source</a><a href="#method.serialize_tuple_struct" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_tuple_struct" class="fnname">serialize_tuple_struct</a>(<br> self,<br> _name: &'static str,<br> _len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTupleStruct" title="type serde::Serializer::SerializeTupleStruct">SerializeTupleStruct</a>, Error></h4></section><section id="method.serialize_tuple_variant" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#136-144">source</a><a href="#method.serialize_tuple_variant" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_tuple_variant" class="fnname">serialize_tuple_variant</a>(<br> self,<br> _name: &'static str,<br> _variant_index: u32,<br> _variant: &'static str,<br> _len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeTupleVariant" title="type serde::Serializer::SerializeTupleVariant">SerializeTupleVariant</a>, Error></h4></section><section id="method.serialize_map" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#146-148">source</a><a href="#method.serialize_map" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_map" class="fnname">serialize_map</a>(self, _len: Option<usize>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeMap" title="type serde::Serializer::SerializeMap">SerializeMap</a>, Error></h4></section><section id="method.serialize_struct" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#150-156">source</a><a href="#method.serialize_struct" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_struct" class="fnname">serialize_struct</a>(<br> self,<br> _name: &'static str,<br> _len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeStruct" title="type serde::Serializer::SerializeStruct">SerializeStruct</a>, Error></h4></section><section id="method.serialize_struct_variant" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#158-166">source</a><a href="#method.serialize_struct_variant" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.serialize_struct_variant" class="fnname">serialize_struct_variant</a>(<br> self,<br> _name: &'static str,<br> _variant_index: u32,<br> _variant: &'static str,<br> _len: usize<br>) -> Result<Self::<a class="associatedtype" href="trait.Serializer.html#associatedtype.SerializeStructVariant" title="type serde::Serializer::SerializeStructVariant">SerializeStructVariant</a>, Error></h4></section><section id="method.collect_str-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/serde/ser/fmt.rs.html#168-173">source</a><a href="#method.collect_str-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.collect_str" class="fnname">collect_str</a><T: ?Sized>(self, value: &T) -> Result<span class="where fmt-newline">where<br> T: Display,</span></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/serde/ser/trait.Serializer.js" data-ignore-extern-crates="core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
