Struct xml_builder::XML

pub struct XML { /* fields omitted */ }

Structure representing a XML document. It must be used to create a XML document.

Implementations

impl XML

pub fn new() -> Self

Instantiates a XML object.

pub fn set_header_rendering(&mut self, asked: bool)

Does not render XML header for this document.

Can be used in case of a custom XML implementation such as XMLTV.

Arguments

• asked - A boolean value indicating whether we want header rendering.

pub fn set_version(&mut self, version: XMLVersion)

Sets the XML version attribute field.

Arguments

version - An enum value representing the new version to use for the XML.

pub fn set_encoding(&mut self, encoding: String)

Sets the XML encoding attribute field.

Arguments

encoding - A String representing the encoding to use for the document.

pub fn set_attribute_sorting(&mut self, should_sort: bool)

Sets the header attribute sort.

Arguments

should_sort - A boolean value indicating whether we want attributes to be sorted.

pub fn set_custom_header(&mut self, custom_header: String)

Sets a custom XML header.

Be careful, no syntax and semantic verifications are made on this header.

Arguments

custom_header - A String containing the new header value to set for the XML.

pub fn set_root_element(&mut self, element: XMLElement)

Sets the XML document root element.

Arguments

element - An XMLElement qualified as root for the XML document.

pub fn set_document_indentation(&mut self, should_indent: bool)

Sets the XML indentation.

Setting a false value will lower final XML document size.

Arguments

should_indent - A boolean value indicating whether we want indentation for the document.

pub fn build<W: Write>(self, writer: W) -> Result<()>

Builds an XML document into the specified writer implementing Write trait.

Consumes the XML object.

Trait Implementations

impl Default for XML

fn default() -> Self

Returns the “default value” for a type.