Struct quick_xml::se::Serializer

pub struct Serializer<'w, 'r, W: Write> { /* private fields */ }

Available on crate feature serialize only.

A Serializer

Implementations

impl<'w, 'r, W: Write> Serializer<'w, 'r, W>

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

pub fn with_root( writer: &'w mut W, root_tag: Option<&'r str>, ) -> Result<Self, DeError>

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>"
);

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>"
);

pub fn indent(&mut self, indent_char: char, indent_size: usize) -> &mut Self

Configure indent for a serializer

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

impl<'w, 'r, W: Write> Serializer for Serializer<'w, 'r, W>

type Ok = ()

The output type produced by this 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.

type Error = DeError

The error type when some error occurs during serialization.

type SerializeSeq = ElementSerializer<'w, 'r, W>

Type returned from serialize_seq for serializing the content of the sequence.

type SerializeTuple = ElementSerializer<'w, 'r, W>

Type returned from serialize_tuple for serializing the content of the tuple.

type SerializeTupleStruct = ElementSerializer<'w, 'r, W>

Type returned from serialize_tuple_struct for serializing the content of the tuple struct.

type SerializeTupleVariant = Tuple<'w, 'r, W>

Type returned from serialize_tuple_variant for serializing the content of the tuple variant.

type SerializeMap = Map<'w, 'r, W>

Type returned from serialize_map for serializing the content of the map.

type SerializeStruct = Struct<'w, 'r, W>

Type returned from serialize_struct for serializing the content of the struct.

type SerializeStructVariant = Struct<'w, 'r, W>

Type returned from serialize_struct_variant for serializing the content of the struct variant.

fn serialize_bool(self, value: bool) -> Result<Self::Ok, Self::Error>

Serialize a bool value.

fn serialize_i8(self, value: i8) -> Result<Self::Ok, Self::Error>

Serialize an i8 value.

fn serialize_i16(self, value: i16) -> Result<Self::Ok, Self::Error>

Serialize an i16 value.

fn serialize_i32(self, value: i32) -> Result<Self::Ok, Self::Error>

Serialize an i32 value.

fn serialize_i64(self, value: i64) -> Result<Self::Ok, Self::Error>

Serialize an i64 value.

fn serialize_u8(self, value: u8) -> Result<Self::Ok, Self::Error>

Serialize a u8 value.

fn serialize_u16(self, value: u16) -> Result<Self::Ok, Self::Error>

Serialize a u16 value.

fn serialize_u32(self, value: u32) -> Result<Self::Ok, Self::Error>

Serialize a u32 value.

fn serialize_u64(self, value: u64) -> Result<Self::Ok, Self::Error>

Serialize a u64 value.

fn serialize_i128(self, value: i128) -> Result<Self::Ok, Self::Error>

Serialize an i128 value.

fn serialize_u128(self, value: u128) -> Result<Self::Ok, Self::Error>

Serialize a u128 value.

fn serialize_f32(self, value: f32) -> Result<Self::Ok, Self::Error>

Serialize an f32 value.

fn serialize_f64(self, value: f64) -> Result<Self::Ok, Self::Error>

Serialize an f64 value.

fn serialize_char(self, value: char) -> Result<Self::Ok, Self::Error>

Serialize a character.

fn serialize_str(self, value: &str) -> Result<Self::Ok, Self::Error>

Serialize a &str.

fn serialize_bytes(self, value: &[u8]) -> Result<Self::Ok, Self::Error>

Serialize a chunk of raw byte data.

fn serialize_none(self) -> Result<Self::Ok, DeError>

Serialize a None value.

fn serialize_some<T: ?Sized + Serialize>( self, value: &T, ) -> Result<Self::Ok, DeError>

Serialize a Some(T) value.

fn serialize_unit(self) -> Result<Self::Ok, DeError>

Serialize a () value.

fn serialize_unit_struct(self, name: &'static str) -> Result<Self::Ok, DeError>

Serialize a unit struct like struct Unit or PhantomData<T>.

fn serialize_unit_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, ) -> Result<Self::Ok, DeError>

Serialize a unit variant like E::A in enum E { A, B }.

fn serialize_newtype_struct<T: ?Sized + Serialize>( self, name: &'static str, value: &T, ) -> Result<Self::Ok, DeError>

Serialize a newtype struct like struct Millimeters(u8).

fn serialize_newtype_variant<T: ?Sized + Serialize>( self, _name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result<Self::Ok, DeError>

Serialize a newtype variant like E::N in enum E { N(u8) }.

fn serialize_seq( self, len: Option<usize>, ) -> Result<Self::SerializeSeq, DeError>

Begin to serialize a variably sized sequence. This call must be followed by zero or more calls to serialize_element, then a call to end.

fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple, DeError>

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 serialize_element, then a call to end.

fn serialize_tuple_struct( self, name: &'static str, len: usize, ) -> Result<Self::SerializeTupleStruct, DeError>

Begin to serialize a tuple struct like struct Rgb(u8, u8, u8). This call must be followed by zero or more calls to serialize_field, then a call to end.

fn serialize_tuple_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeTupleVariant, DeError>

Begin to serialize a tuple variant like 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.

fn serialize_map( self, len: Option<usize>, ) -> Result<Self::SerializeMap, DeError>

Begin to serialize a map. This call must be followed by zero or more calls to serialize_key and serialize_value, then a call to end.

fn serialize_struct( self, name: &'static str, len: usize, ) -> Result<Self::SerializeStruct, DeError>

Begin to serialize a struct like 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.

fn serialize_struct_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize, ) -> Result<Self::SerializeStructVariant, DeError>

Begin to serialize a struct variant like 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.

fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where I: IntoIterator, <I as IntoIterator>::Item: Serialize,

Collect an iterator as a sequence.

fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>

where K: Serialize, V: Serialize, I: IntoIterator<Item = (K, V)>,

Collect an iterator as a map.

fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>

where T: Display + ?Sized,

Available on crate features std or alloc only.

Serialize a string produced by an implementation of Display.

fn is_human_readable(&self) -> bool

Determine whether Serialize implementations should serialize in human-readable form.