Struct Document

pub struct Document { /* private fields */ }

A well-formed XML document with one root element.

Equality is semantic: two documents are equal when their declaration, prolog, root, and epilog match. Retained source text and spans are provenance and do not participate, so a document compares equal to itself after Document::without_source.

Implementations

impl Document

pub fn validate_schema(&self) -> SchemaReport

Validates this document against the ISO 23387 element grammar.

This is a stricter, structural check than Document::validate, which reports advisory diagnostics. A conforming report means every checked rule held: declared root, child sequence and cardinality, attribute presence, and datatype facets.

impl Document

pub fn parse(xml: &str) -> Result<Self, ParseError>

Parses with conservative production defaults.

pub fn parse_with_options( xml: &str, options: ParseOptions, ) -> Result<Self, ParseError>

Parses with explicit resource limits.

pub const fn declaration(&self) -> Option<&XmlDeclaration>

pub fn prolog(&self) -> &[Node]

pub const fn root(&self) -> &Element

pub fn epilog(&self) -> &[Node]

pub fn source(&self) -> Option<&str>

The exact text this document was parsed from, when it is still retained.

pub fn without_source(self) -> Self

Drops the retained source text, keeping the semantic tree.

Useful when a caller wants to hold many documents in memory and does not need byte-exact output. Afterwards Document::to_xml_string_exact fails closed instead of reconstructing approximate bytes.

pub fn to_xml_string(&self) -> Result<String, WriteError>

Serializes the semantic XML tree without dropping retained content.

Equivalent syntax may be normalized; use Document::to_xml_string_exact when the output must match the parsed bytes.

pub fn to_xml_string_exact(&self) -> Result<String, ExactWriteError>

Reproduces the parsed document byte-for-byte from retained source spans.

Every construct is emitted from the exact bytes the reader consumed, so attribute quoting, character-reference spelling, intra-tag whitespace, CDATA versus escaped text, and empty-element syntax all survive unchanged. The call fails rather than falling back to normalization when span provenance is missing.

impl Document

pub fn root_kind(&self) -> Option<ElementKind>

pub fn library(&self) -> Option<Library<'_>>

pub fn into_root_element(self) -> Element

Separates the root for embedding or conversion into an owned DT type.

impl Document

pub fn validate(&self) -> Vec<Diagnostic>

Runs structural checks that do not require redistributing the ISO schema.

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 PartialEq for Document

fn eq(&self, other: &Self) -> 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