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 FormatSerializer for XmlSerializer

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

For XML, None values should not emit any content. We skip emitting an element entirely rather than writing <field>null</field>.

type Error = XmlSerializeError

Format-specific error type.

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

Begin a map/object/struct.

fn field_key(&mut self, key: &str) -> Result<(), Self::Error>

Emit a field key within a struct.

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

End a map/object/struct.

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

Begin a sequence/array.

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

End a sequence/array.

fn scalar(&mut self, scalar: ScalarValue<'_>) -> Result<(), Self::Error>

Emit a scalar value.

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

Optional: Provide field metadata before field_key is called. This allows formats like XML to extract namespace information. Default implementation does nothing.

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

Optional: Provide struct/enum type metadata when beginning to serialize it. This allows formats to extract container-level attributes like xml::ns_all. Default implementation does nothing.

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

Optional: Provide variant metadata before serializing an enum variant. This allows formats like XML to use the variant name as the element name for xml::elements serialization. Default implementation does nothing.

fn preferred_field_order(&self) -> FieldOrdering

Preferred field ordering for this format. Formats like XML can request attributes-first ordering to avoid buffering. Default is declaration order.

fn raw_serialize_shape(&self) -> Option<&'static Shape>

Returns the shape of the format’s raw capture type for serialization.

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

Emit a raw scalar value (for RawJson, etc.) without any encoding/escaping.

fn begin_seq_with_len(&mut self, _len: usize) -> Result<(), Self::Error>

Begin a sequence with known length.

fn typed_scalar( &mut self, scalar_type: ScalarType, value: Peek<'_, '_>, ) -> Result<(), Self::Error>

Serialize a scalar with full type information.

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

Begin serializing Option::Some(value).

fn begin_enum_variant( &mut self, _variant_index: usize, _variant_name: &'static str, ) -> Result<(), Self::Error>

Begin an enum variant with its index and name.