Struct Document

pub struct Document {
    pub version: XmlVersion,
    pub encoding: String,
    pub root: Option<Element>,
}

An XML document

Fields

version: XmlVersion

Version of the XML document

encoding: String

Encoding of the XML document

root: Option<Element>

Root tag of the XML document

Implementations

impl Document

pub fn new() -> Document

Create a new Document with default values

pub fn build(root: &mut ElementBuilder) -> Self

Create a new Document with an Element or ElementBuilder at its root.

pub fn parse<R: Read>(r: R) -> Result<Document, Error>

Parse data from a reader to construct an XML document

Failures

Passes any errors that the xml-rs library returns up the stack

pub fn write<W: Write>(&self, w: &mut W) -> Result<(), Error>

pub fn write_with<W: Write>( &self, w: &mut W, document_decl: bool, indent_str: &'static str, indent: bool, ) -> Result<(), Error>

Writes a document to w

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Display for Document

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

Formats the value using the given formatter.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Document

impl StructuralPartialEq for Document