Struct XmlPrinter 

pub struct XmlPrinter { /* private fields */ }

An XML serialization and streaming engine.

Implements XmlVisitor to serialize an in-memory Document, and provides a stateful streaming API for manual XML generation without a DOM tree.

Implementations

impl XmlPrinter

pub fn new() -> Self

Creates a new pretty-printing printer.

The default indentation is 4 spaces.

pub fn new_compact() -> Self

Creates a new compact printer.

Compact mode outputs XML with zero indentation or newlines between elements.

pub fn compact() -> Self

Creates a new compact printer. Alias for Self::new_compact.

pub fn with_capacity(capacity: usize, compact: bool) -> Self

Creates a printer with a pre-allocated capacity.

pub fn set_bom(&mut self, use_bom: bool)

Configures whether to emit the UTF-8 Byte Order Mark (BOM).

pub fn set_indent_str(&mut self, indent_str: &str)

Configures the indentation string used in pretty-printed mode.

pub fn clear(&mut self)

Clears the printer’s state and buffer for reuse.

pub fn as_str(&self) -> &str

Returns the accumulated XML output as a string slice.

pub fn result(&self) -> &str

Returns the accumulated XML output as a string slice. Alias for Self::as_str.

pub fn into_string(self) -> String

Consumes the printer and returns the accumulated XML string.

pub fn len(&self) -> usize

Returns the current length of the output buffer in bytes.

pub fn is_empty(&self) -> bool

Returns true if the output buffer is empty.

pub fn push_header( &mut self, version: &str, encoding: Option<&str>, standalone: Option<bool>, )

Writes the XML declaration: <?xml version="..." encoding="..." standalone="..."?>

pub fn open_element(&mut self, name: &str)

Opens an XML element: <name (remains open for attributes).

pub fn push_attribute(&mut self, name: &str, value: &str)

Pushes an attribute key-value pair to the currently open element.

Panics

Panics if no element is currently open for attributes.

pub fn close_element(&mut self)

Closes the currently open XML element: /> or </name>.

pub fn push_text(&mut self, text: &str)

Pushes entity-escaped text content.

pub fn push_text_raw(&mut self, text: &str)

Pushes unescaped raw text content.

pub fn push_cdata(&mut self, text: &str)

Pushes a CDATA section: <![CDATA[text]]>.

pub fn push_comment(&mut self, text: &str)

Pushes a comment: <!--text-->.

pub fn push_declaration(&mut self, text: &str)

Pushes a declaration block: <?text?>.

pub fn push_unknown(&mut self, text: &str)

Pushes an unknown block: <!text>.

pub fn push_declaration_node(&mut self, name: &str, attrs: &[Attribute])

Pushes a declaration node with attributes: <?name attr="value"?>.

Trait Implementations

impl Default for XmlPrinter

fn default() -> Self

Returns the “default value” for a type.

impl XmlVisitor for XmlPrinter

fn visit_enter_document(&mut self, doc: &Document) -> bool

Called when entering the Document (before any children).

fn visit_exit_document(&mut self, _doc: &Document) -> bool

Called when exiting the Document (after all children).

fn visit_enter_element(&mut self, doc: &Document, element: NodeId) -> bool

Called when entering an Element node (before children).

fn visit_exit_element(&mut self, _doc: &Document, _element: NodeId) -> bool

Called when leaving an Element node (after children).

fn visit_text(&mut self, doc: &Document, text: NodeId) -> bool

Called when visiting a Text node.

fn visit_comment(&mut self, doc: &Document, comment: NodeId) -> bool

Called when visiting a Comment node.

fn visit_declaration(&mut self, doc: &Document, declaration: NodeId) -> bool

Called when visiting a Declaration node.

fn visit_unknown(&mut self, doc: &Document, unknown: NodeId) -> bool

Called when visiting an Unknown node.