Struct Serializer 

pub struct Serializer { /* private fields */ }

Serializes values to XML.

This is the XML implementation of the Serializer trait, which allows serializing to XML where the format is not known upfront. For a value that is serialized once SerializerConfig::to_string (or to_string) is simpler.

An XML document has a single root element, serializing a second value fails. Values without a name (like maps) need a Root or the name of the root element in the configuration (see SerializerConfig::set_root).

use std::collections::BTreeMap;
use deser_xml::{Serializer, SerializerConfig};

let mut serializer = Serializer::with_config(SerializerConfig::builder().root("r").build());
serializer.serialize(&BTreeMap::from([("@a", 1), ("b", 2)])).unwrap();
assert!(serializer.serialize(&BTreeMap::from([("b", 3)])).is_err());
assert_eq!(serializer.finish(), r#"<r a="1"><b>2</b></r>"#);

The serializer is also the stream serializer of XML (see StreamSerializer): the output can be taken while the document is written, and large documents can be written in parts. Output is final once the start tag it’s in is complete: the start tag of an element is held back until no more attributes can come, which for maps (whose keys are not known upfront) is the end of the element. The namespaces that are found once the start tag of the root element was written are declared on the elements that use them rather than on the root element (configured namespaces are always declared on the root element). To write to a Write use SerializerConfig::writer.

Implementations

impl Serializer

pub fn new() -> Serializer

Creates a serializer.

pub fn with_config(config: SerializerConfig) -> Serializer

Creates a serializer with the given configuration.

pub fn config(&self) -> &SerializerConfig

Returns the configuration.

pub fn written(&self) -> bool

Returns true once the document was written.

pub fn serialize<T: Serialize + ?Sized>( &mut self, value: &T, ) -> Result<(), Error>

Serializes a value.

If the value fails to serialize, nothing is written.

pub fn serialize_with<F, T: Serialize + ?Sized>( &mut self, value: &T, setup: F, ) -> Result<(), Error>

where F: FnOnce(&mut SerializeDriver<'_>),

Serializes a value with a configured driver.

The callback is invoked with the driver before the value is serialized, for instance to add Layers.

pub fn as_str(&self) -> &str

Returns the output written so far (that was not cleared).

pub fn finish(self) -> String

Returns the output.

Trait Implementations

impl Clone for Serializer

fn clone(&self) -> Serializer

Clones the serializer.

The clone of a serializer that writes a document in parts cannot write more values (see StreamSerializer::in_progress).

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Serializer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Serializer

fn default() -> Serializer

Returns the “default value” for a type.

impl Serializer for Serializer

fn drive(&mut self, driver: &mut SerializeDriver<'_>) -> Result<(), Error>

Receives the events of a value from the driver and writes them into the output.

fn serialize<T>(&mut self, value: &T) -> Result<(), Error>

where T: Serialize + ?Sized, Self: Sized,

Serializes a value.

fn serialize_with<T, F>(&mut self, value: &T, setup: F) -> Result<(), Error>

where T: Serialize + ?Sized, F: FnOnce(&mut SerializeDriver<'_>), Self: Sized,

Serializes a value with a configured driver.

fn serialize_ref(&mut self, value: SerializeRef<'_>) -> Result<(), Error>

Serializes the value of a reference.

impl StreamSerializer for Serializer

fn output(&self) -> &[u8]

Returns the bytes serialized so far which were not cleared yet.

fn clear_output(&mut self)

Discards the bytes returned by output, for instance because they were written.

fn supports_partial(&self) -> bool

Returns true if the serializer implements drive_partial.

fn drive_partial( &mut self, driver: &mut SerializeDriver<'_>, limit: usize, ) -> Result<bool, Error>

Serializes a value, or a part of it, and appends its bytes to the output.

fn in_progress(&self) -> bool

Returns true if a value is partially serialized.