Struct exile::Document

pub struct Document { /* fields omitted */ }

Represents an XML Document.

Implementations

impl<'a> Document

pub fn new() -> Document

Create a new default document.

impl Document

pub fn from_root(root: Element) -> Self

Construct a new Document using the given Element as the root.

pub fn root(&self) -> &Element

Get the root Element.

pub fn set_root(&mut self, element_data: Element)

Set the root Element.

pub fn root_mut(&mut self) -> &mut Element

Get a mutable reference to the root Element.

pub fn declaration(&self) -> &Declaration

Get the Declaration object.

pub fn set_declaration(&mut self, declaration: Declaration)

Set the Declaration object for the Document.

pub fn set_doctype<S: Into<String>>(&mut self, _: S) -> Result<(), XDocErr>

Disabled doctype setter.

pub fn add_prolog_comment<S: Into<String>>(
    &mut self,
    comment: S
) -> Result<(), XDocErr>

Add a comment before the document root element.

pub fn add_prolog_pi(&mut self, pi: Pi)

Add a processing instruction before the document root element.

pub fn clear_prolog_misc(&mut self)

Remove all [PI] and comment entries before the root element.

pub fn prolog_misc(&self) -> impl Iterator<Item = &Misc> + '_

Access the Misc entries before the root element.

pub fn add_epilog_comment<S: Into<String>>(
    &mut self,
    comment: S
) -> Result<(), XDocErr>

Add a comment after the document root element.

pub fn add_epilog_pi(&mut self, pi: Pi)

Add a processing instruction after the document root element.

pub fn clear_epilog_misc(&mut self)

Clear all Misc entries after the root element.

pub fn epilog_misc(&self) -> Iter<'_, Misc>

Access the Misc entries after the root element.

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

Write the Document to the Write object.

pub fn write_opts<W>(
    &self,
    writer: &mut W,
    opts: &WriteOpts
) -> Result<(), XDocErr> where
    W: Write, 

Write the Document to the Write object using the given options.

pub fn to_string_opts(&self, opts: &WriteOpts) -> Result<String, XDocErr>

Write the Document to a String using the given options.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save a document to a file.

pub fn index(self) -> Index

Create an index of the elements in this document. Takes ownership of document.

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() -> Document

Returns the “default value” for a type.

impl Hash for Document

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Document> for Document

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Document> for Document

fn partial_cmp(&self, other: &Document) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToString for Document

fn to_string(&self) -> String

Converts the given value to a String.

impl Eq for Document

impl StructuralEq for Document

impl StructuralPartialEq for Document

impl Unpin for Document