Struct Document 

pub struct Document { /* private fields */ }

A parsed XML document.

Implementations

impl Document

pub fn size(&self) -> usize

The number of nodes, including the document root.

pub fn root_name(&self) -> Option<String>

The name of the root element, if there is one.

pub fn query_text( &self, expression: &str, namespaces: Option<Vec<String>>, ) -> Result<Vec<String>, JsError>

Evaluate an XPath expression and return the matched nodes’ text, as an array of strings.

Returning text rather than node handles is deliberate: a NodeId is only meaningful against the document that issued it, and handing an opaque integer across the WASM boundary invites exactly the misuse the Rust API’s lifetime rules prevent.

namespaces binds prefixes for the expression, each written "PREFIX=URI" — the same spelling oxml-cli takes for --ns. A prefix resolves against these bindings and not against the document, so one query works across documents that spell the prefix differently. An unbound prefix is an error.

Errors

Returns a JsError if the expression is malformed or uses an unbound prefix.

pub fn query_value( &self, expression: &str, namespaces: Option<Vec<String>>, ) -> Result<String, JsError>

Evaluate an XPath expression and return its value as a string.

Use this for expressions that are not node-sets — count(..), string(..), a comparison.

namespaces binds prefixes for the expression, each written "PREFIX=URI" — the same spelling oxml-cli takes for --ns. A prefix resolves against these bindings and not against the document, so one query works across documents that spell the prefix differently. An unbound prefix is an error.

Errors

Returns a JsError if the expression is malformed or uses an unbound prefix.

pub fn query_count( &self, expression: &str, namespaces: Option<Vec<String>>, ) -> Result<usize, JsError>

How many nodes an expression matches.

namespaces binds prefixes for the expression, each written "PREFIX=URI" — the same spelling oxml-cli takes for --ns. A prefix resolves against these bindings and not against the document, so one query works across documents that spell the prefix differently. An unbound prefix is an error.

Errors

Returns a JsError if the expression is malformed or uses an unbound prefix.

pub fn to_xml(&self) -> String

The document as XML.

The counterpart to parse. Reading a document and writing it back previously meant reaching for XMLSerializer and holding two representations of the same thing.

Round-trips: the output parses to a document that serialises identically. It is not guaranteed byte-identical to the input, because a document has more than one valid spelling – entity references and attribute order among them.

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl From<Document> for JsValue

fn from(value: Document) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Document

type Abi = WasmPtr<WasmRefCell<Document>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Document

type Abi = WasmPtr<WasmRefCell<Document>>

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for Document

type Abi = WasmPtr<WasmRefCell<Document>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Document>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Document

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Document

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Document

type Abi = WasmPtr<WasmRefCell<Document>>

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Document>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Document

type Abi = WasmPtr<WasmRefCell<Document>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Document>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl SupportsConstructor for Document

impl SupportsInstanceProperty for Document

impl SupportsStaticProperty for Document

impl TryFromJsValue for Document

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for Document

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Document]>

impl VectorIntoWasmAbi for Document

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Document]>) -> Self::Abi

impl WasmDescribe for Document

fn describe()

impl WasmDescribeVector for Document

fn describe_vector()