pub struct Serializer<'w, 'r, W: Write> { /* private fields */ }
serialize
only.Expand description
A Serializer.
Returns the classification of the last written type.
Implementations§
Source§impl<'w, 'r, W: Write> Serializer<'w, 'r, W>
impl<'w, 'r, W: Write> Serializer<'w, 'r, W>
Sourcepub fn new(writer: &'w mut W) -> Self
pub fn new(writer: &'w mut W) -> Self
Creates a new Serializer
that uses struct name as a root tag name.
Note, that attempt to serialize a non-struct (including unit structs
and newtype structs) will end up to an error. Use with_root
to create
serializer with explicitly defined root element name
Sourcepub fn with_root(
writer: &'w mut W,
root_tag: Option<&'r str>,
) -> Result<Self, SeError>
pub fn with_root( writer: &'w mut W, root_tag: Option<&'r str>, ) -> Result<Self, SeError>
Creates a new Serializer
that uses specified root tag name. name
should
be valid XML name, otherwise error is returned.
§Examples
When serializing a primitive type, only its representation will be written:
let mut buffer = String::new();
let ser = Serializer::with_root(&mut buffer, Some("root")).unwrap();
"node".serialize(ser).unwrap();
assert_eq!(buffer, "<root>node</root>");
When serializing a struct, newtype struct, unit struct or tuple root_tag
is used as tag name of root(s) element(s):
#[derive(Debug, PartialEq, Serialize)]
struct Struct {
question: String,
answer: u32,
}
let mut buffer = String::new();
let ser = Serializer::with_root(&mut buffer, Some("root")).unwrap();
let data = Struct {
question: "The Ultimate Question of Life, the Universe, and Everything".into(),
answer: 42,
};
data.serialize(ser).unwrap();
assert_eq!(
buffer,
"<root>\
<question>The Ultimate Question of Life, the Universe, and Everything</question>\
<answer>42</answer>\
</root>"
);
Sourcepub fn expand_empty_elements(&mut self, expand: bool) -> &mut Self
pub fn expand_empty_elements(&mut self, expand: bool) -> &mut Self
Enable or disable expansion of empty elements. Defaults to false
.
§Examples
#[derive(Debug, PartialEq, Serialize)]
struct Struct {
question: Option<String>,
}
let mut buffer = String::new();
let mut ser = Serializer::new(&mut buffer);
ser.expand_empty_elements(true);
let data = Struct {
question: None,
};
data.serialize(ser).unwrap();
assert_eq!(
buffer,
"<Struct><question></question></Struct>"
);
Sourcepub fn indent(&mut self, indent_char: char, indent_size: usize) -> &mut Self
pub fn indent(&mut self, indent_char: char, indent_size: usize) -> &mut Self
Configure indent for a serializer
Sourcepub fn set_quote_level(&mut self, level: QuoteLevel) -> &mut Self
pub fn set_quote_level(&mut self, level: QuoteLevel) -> &mut Self
Set the level of quoting used when writing texts
Default: QuoteLevel::Minimal
Trait Implementations§
Source§impl<'w, 'r, W: Write> Serializer for Serializer<'w, 'r, W>
impl<'w, 'r, W: Write> Serializer for Serializer<'w, 'r, W>
Source§type Ok = WriteResult
type Ok = WriteResult
Serializer
during successful
serialization. Most serializers that produce text or binary output
should set Ok = ()
and serialize into an io::Write
or buffer
contained within the Serializer
instance. Serializers that build
in-memory data structures may be simplified by using Ok
to propagate
the data structure around.Source§type SerializeSeq = ElementSerializer<'w, 'r, W>
type SerializeSeq = ElementSerializer<'w, 'r, W>
serialize_seq
for serializing the content of the
sequence.Source§type SerializeTuple = ElementSerializer<'w, 'r, W>
type SerializeTuple = ElementSerializer<'w, 'r, W>
serialize_tuple
for serializing the content of
the tuple.Source§type SerializeTupleStruct = ElementSerializer<'w, 'r, W>
type SerializeTupleStruct = ElementSerializer<'w, 'r, W>
serialize_tuple_struct
for serializing the
content of the tuple struct.Source§type SerializeTupleVariant = Tuple<'w, 'r, W>
type SerializeTupleVariant = Tuple<'w, 'r, W>
serialize_tuple_variant
for serializing the
content of the tuple variant.Source§type SerializeMap = Map<'w, 'r, W>
type SerializeMap = Map<'w, 'r, W>
serialize_map
for serializing the content of the
map.Source§type SerializeStruct = Struct<'w, 'r, W>
type SerializeStruct = Struct<'w, 'r, W>
serialize_struct
for serializing the content of
the struct.Source§type SerializeStructVariant = Struct<'w, 'r, W>
type SerializeStructVariant = Struct<'w, 'r, W>
serialize_struct_variant
for serializing the
content of the struct variant.Source§fn serialize_bool(self, value: bool) -> Result<Self::Ok, Self::Error>
fn serialize_bool(self, value: bool) -> Result<Self::Ok, Self::Error>
bool
value. Read moreSource§fn serialize_i8(self, value: i8) -> Result<Self::Ok, Self::Error>
fn serialize_i8(self, value: i8) -> Result<Self::Ok, Self::Error>
i8
value. Read moreSource§fn serialize_i16(self, value: i16) -> Result<Self::Ok, Self::Error>
fn serialize_i16(self, value: i16) -> Result<Self::Ok, Self::Error>
i16
value. Read moreSource§fn serialize_i32(self, value: i32) -> Result<Self::Ok, Self::Error>
fn serialize_i32(self, value: i32) -> Result<Self::Ok, Self::Error>
i32
value. Read moreSource§fn serialize_i64(self, value: i64) -> Result<Self::Ok, Self::Error>
fn serialize_i64(self, value: i64) -> Result<Self::Ok, Self::Error>
i64
value. Read moreSource§fn serialize_u8(self, value: u8) -> Result<Self::Ok, Self::Error>
fn serialize_u8(self, value: u8) -> Result<Self::Ok, Self::Error>
u8
value. Read moreSource§fn serialize_u16(self, value: u16) -> Result<Self::Ok, Self::Error>
fn serialize_u16(self, value: u16) -> Result<Self::Ok, Self::Error>
u16
value. Read moreSource§fn serialize_u32(self, value: u32) -> Result<Self::Ok, Self::Error>
fn serialize_u32(self, value: u32) -> Result<Self::Ok, Self::Error>
u32
value. Read moreSource§fn serialize_u64(self, value: u64) -> Result<Self::Ok, Self::Error>
fn serialize_u64(self, value: u64) -> Result<Self::Ok, Self::Error>
u64
value. Read moreSource§fn serialize_i128(self, value: i128) -> Result<Self::Ok, Self::Error>
fn serialize_i128(self, value: i128) -> Result<Self::Ok, Self::Error>
i128
value. Read moreSource§fn serialize_u128(self, value: u128) -> Result<Self::Ok, Self::Error>
fn serialize_u128(self, value: u128) -> Result<Self::Ok, Self::Error>
u128
value. Read moreSource§fn serialize_f32(self, value: f32) -> Result<Self::Ok, Self::Error>
fn serialize_f32(self, value: f32) -> Result<Self::Ok, Self::Error>
f32
value. Read moreSource§fn serialize_f64(self, value: f64) -> Result<Self::Ok, Self::Error>
fn serialize_f64(self, value: f64) -> Result<Self::Ok, Self::Error>
f64
value. Read moreSource§fn serialize_char(self, value: char) -> Result<Self::Ok, Self::Error>
fn serialize_char(self, value: char) -> Result<Self::Ok, Self::Error>
Source§fn serialize_str(self, value: &str) -> Result<Self::Ok, Self::Error>
fn serialize_str(self, value: &str) -> Result<Self::Ok, Self::Error>
&str
. Read moreSource§fn serialize_bytes(self, value: &[u8]) -> Result<Self::Ok, Self::Error>
fn serialize_bytes(self, value: &[u8]) -> Result<Self::Ok, Self::Error>
Source§fn serialize_some<T: ?Sized + Serialize>(
self,
value: &T,
) -> Result<Self::Ok, Self::Error>
fn serialize_some<T: ?Sized + Serialize>( self, value: &T, ) -> Result<Self::Ok, Self::Error>
Source§fn serialize_unit_variant(
self,
name: &'static str,
_variant_index: u32,
variant: &'static str,
) -> Result<Self::Ok, Self::Error>
fn serialize_unit_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, ) -> Result<Self::Ok, Self::Error>
Source§fn serialize_newtype_struct<T: ?Sized + Serialize>(
self,
name: &'static str,
value: &T,
) -> Result<Self::Ok, Self::Error>
fn serialize_newtype_struct<T: ?Sized + Serialize>( self, name: &'static str, value: &T, ) -> Result<Self::Ok, Self::Error>
struct Millimeters(u8)
. Read moreSource§fn serialize_newtype_variant<T: ?Sized + Serialize>(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str,
value: &T,
) -> Result<Self::Ok, Self::Error>
fn serialize_newtype_variant<T: ?Sized + Serialize>( self, _name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result<Self::Ok, Self::Error>
Source§fn serialize_seq(
self,
len: Option<usize>,
) -> Result<Self::SerializeSeq, Self::Error>
fn serialize_seq( self, len: Option<usize>, ) -> Result<Self::SerializeSeq, Self::Error>
serialize_element
, then a call to
end
. Read moreSource§fn serialize_tuple(
self,
len: usize,
) -> Result<Self::SerializeTuple, Self::Error>
fn serialize_tuple( self, len: usize, ) -> Result<Self::SerializeTuple, Self::Error>
serialize_element
,
then a call to end
. Read moreSource§fn serialize_tuple_struct(
self,
name: &'static str,
len: usize,
) -> Result<Self::SerializeTupleStruct, Self::Error>
fn serialize_tuple_struct( self, name: &'static str, len: usize, ) -> Result<Self::SerializeTupleStruct, Self::Error>
struct Rgb(u8, u8, u8)
. This
call must be followed by zero or more calls to serialize_field
, then a
call to end
. Read moreSource§fn serialize_tuple_variant(
self,
name: &'static str,
_variant_index: u32,
variant: &'static str,
len: usize,
) -> Result<Self::SerializeTupleVariant, Self::Error>
fn serialize_tuple_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeTupleVariant, Self::Error>
E::T
in enum E { T(u8, u8) }
. This call must be followed by zero or more calls to
serialize_field
, then a call to end
. Read moreSource§fn serialize_map(
self,
len: Option<usize>,
) -> Result<Self::SerializeMap, Self::Error>
fn serialize_map( self, len: Option<usize>, ) -> Result<Self::SerializeMap, Self::Error>
serialize_key
and serialize_value
, then a call to end
. Read moreSource§fn serialize_struct(
self,
name: &'static str,
len: usize,
) -> Result<Self::SerializeStruct, Self::Error>
fn serialize_struct( self, name: &'static str, len: usize, ) -> Result<Self::SerializeStruct, Self::Error>
struct Rgb { r: u8, g: u8, b: u8 }
.
This call must be followed by zero or more calls to serialize_field
,
then a call to end
. Read moreSource§fn serialize_struct_variant(
self,
name: &'static str,
_variant_index: u32,
variant: &'static str,
len: usize,
) -> Result<Self::SerializeStructVariant, Self::Error>
fn serialize_struct_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeStructVariant, Self::Error>
E::S
in enum E { S { r: u8, g: u8, b: u8 } }
. This call must be followed by zero or more calls to
serialize_field
, then a call to end
. Read moreSource§fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>
fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>
Source§fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>
fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>
Source§fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>
fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>
std
or alloc
only.Display
. Read moreSource§fn is_human_readable(&self) -> bool
fn is_human_readable(&self) -> bool
Serialize
implementations should serialize in
human-readable form. Read more