Documents

Struct Documents 

Source
pub struct Documents { /* private fields */ }
Expand description

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 won’t be changed.

Implementations§

Source§

impl Documents

Source

pub fn new() -> Self

Create a new empty collection of documents.

Source

pub fn add_string( &mut self, uri: &IriStr, xml: &str, ) -> Result<DocumentHandle, DocumentsError>

Load a string as an XML document. Designate it with a URI.

Something may go wrong during processing of the XML document; this is a xot::Error.

Source

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

Load a string as an XML document without designating it with a URI.

Something may go wrong during processing of the XML document; this is a xot::Error.

Source

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

Given a handle give back the document node

Source

pub fn documents(&self) -> &DocumentsRef

Get a reference to the documents

Source

pub fn xot(&self) -> &Xot

Get a reference to the Xot arena

Source

pub fn xot_mut(&mut self) -> &mut Xot

Get a mutable reference to the Xot arena

Trait Implementations§

Source§

impl Debug for Documents

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Documents

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'src, T> IntoMaybe<'src, T> for T
where T: 'src,

Source§

type Proj<U: 'src> = U

Source§

fn map_maybe<R>( self, _f: impl FnOnce(&'src T) -> &'src R, g: impl FnOnce(T) -> R, ) -> <T as IntoMaybe<'src, T>>::Proj<R>
where R: 'src,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T