Struct XmlSerializer 

pub struct XmlSerializer { /* private fields */ }

XML serializer with configurable output options.

The output is designed to round-trip through facet-xml’s parser:

• structs are elements whose children are field elements
• sequences are elements whose children are repeated <item> elements
• element names are treated as map keys; the root element name is ignored

Implementations

impl XmlSerializer

pub fn new() -> Self

Create a new XML serializer with default options.

pub fn with_options(options: SerializeOptions) -> Self

Create a new XML serializer with the given options.

pub fn finish(self) -> Vec<u8>

Trait Implementations

impl Default for XmlSerializer

fn default() -> Self

Returns the “default value” for a type.

impl DomSerializer for XmlSerializer

type Error = XmlSerializeError

Format-specific error type.

fn element_start( &mut self, tag: &str, namespace: Option<&str>, ) -> Result<(), Self::Error>

Begin an element with the given tag name.

fn attribute( &mut self, name: &str, value: Peek<'_, '_>, namespace: Option<&str>, ) -> Result<(), Self::Error>

Emit an attribute on the current element.

fn children_start(&mut self) -> Result<(), Self::Error>

Start the children section of the current element.

fn children_end(&mut self) -> Result<(), Self::Error>

End the children section.

fn element_end(&mut self, _tag: &str) -> Result<(), Self::Error>

End the current element.

fn text(&mut self, content: &str) -> Result<(), Self::Error>

Emit text content.

fn struct_metadata(&mut self, shape: &Shape) -> Result<(), Self::Error>

Provide struct/container metadata before serializing.

fn field_metadata(&mut self, field: &FieldItem) -> Result<(), Self::Error>

Provide field metadata before serializing a field.

fn variant_metadata( &mut self, _variant: &'static Variant, ) -> Result<(), Self::Error>

Provide variant metadata before serializing an enum variant.

fn is_attribute_field(&self) -> bool

Check if the current field should be serialized as an attribute.

fn is_text_field(&self) -> bool

Check if the current field should be serialized as text content.

fn is_elements_field(&self) -> bool

Check if the current field is an “elements” list (no wrapper element).

fn is_doctype_field(&self) -> bool

Check if the current field is a “doctype” field (stores the DOCTYPE declaration).

fn doctype(&mut self, content: &str) -> Result<(), Self::Error>

Emit a DOCTYPE declaration (XML/HTML).

fn clear_field_state(&mut self)

Clear field-related state after a field is serialized.

fn format_float(&self, value: f64) -> String

Format a floating-point value as a string.

fn serialize_none(&mut self) -> Result<(), Self::Error>

Called when serializing None. DOM formats typically skip the field entirely.

fn format_namespace(&self) -> Option<&'static str>

Returns the format namespace for this serializer (e.g., “xml”, “html”).

fn comment(&mut self, _content: &str) -> Result<(), Self::Error>

Emit a comment (usually for debugging or special content).

fn is_tag_field(&self) -> bool

Check if the current field is a “tag” field (stores the element’s tag name).