Struct Documents 

pub struct Documents { /* private fields */ }

A collection of XML documents as can be used by XPath and XSLT.

This collection can be prepared before any XPath or XSLT processing begins.

Alternatively this collection can be added to incrementally during processing using the fn:doc function for instance. Once a document under a URL is present, it cannot be changed anymore.

The fn:parse-xml and fn:parse-xml-fragment functions can be used to create new documents from strings without URLs.

Implementations

impl Documents

pub fn new() -> Documents

Create a new empty collection of documents.

pub fn cleanup(&mut self, xot: &mut Xot)

Clean up all documents.

pub fn add_string( &mut self, xot: &mut Xot, uri: Option<&RiStr<IriSpec>>, xml: &str, ) -> Result<DocumentHandle, DocumentsError>

Add a string as an XML document. It can be designated with a URI.

pub fn add_fragment_string( &mut self, xot: &mut Xot, xml: &str, ) -> Result<DocumentHandle, DocumentsError>

Add a string as an XML fragment.

pub fn add_root( &mut self, uri: Option<&RiStr<IriSpec>>, root: Node, ) -> Result<DocumentHandle, DocumentsError>

Add a root node of an XML document. Designate it with a URI.

pub fn get_by_handle(&self, handle: DocumentHandle) -> Option<&Document>

Obtain a document by handle

pub fn get_node_by_handle(&self, handle: DocumentHandle) -> Option<Node>

Obtain document node by handle

pub fn get_by_uri(&self, uri: &RiStr<IriSpec>) -> Option<&Document>

Obtain a document by URI

It’s only possible to obtain a document by URI if it was added with a URI.

pub fn get_node_by_uri(&self, uri: &RiStr<IriSpec>) -> Option<Node>

Obtain document node by URI

pub fn get_uri_by_document_node(&self, node: Node) -> Option<RiString<IriSpec>>

Obtain document URI by document node.

This only returns a URI if the document was added with a URI.

pub fn len(&self) -> usize

How many documents are stored.

pub fn is_empty(&self) -> bool

Is the collection empty?

Trait Implementations

impl Clone for Documents

fn clone(&self) -> Documents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documents

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

Formats the value using the given formatter.

impl Default for Documents

fn default() -> Documents

Returns the “default value” for a type.

impl From<Documents> for DocumentsRef

fn from(documents: Documents) -> DocumentsRef

Converts to this type from the input type.