Type Alias RNode 

pub type RNode = Rc<Node>;

A node in a tree.

Aliased Type

pub struct RNode { /* private fields */ }

Trait Implementations

impl Node for RNode

fn namespace_iter(&self) -> Self::NodeIterator

Iterator for in-scope namespaces for a node. For a document-type node, if there is a document element then it’s in-scope namespaces are returned. If the document has multiple top-level elements, then the namespaces of the first element-type node are returned. Otherwise, the default “xml” namespace is returned.

fn add_namespace(&self, ns: Self) -> Result<(), Error>

Add a namespace declaration to this element-type node. NOTE: does NOT update the namespace values of the element itself.

type NodeIterator = Box<dyn Iterator<Item = Rc<Node>>>

fn new_document() -> Self

Create a Document-type node. All other types of nodes are created using type-specific methods (new_element, new_text, etc).

fn unattached(&self) -> Vec<Self>

Return a list of nodes that are associated with this document, but are not attached.

fn is_unattached(&self) -> bool

Check if a node is unattached

fn node_type(&self) -> NodeType

Get the type of the node

fn name(&self) -> Option<QName>

Get the name of the node, if it has one. A namespace-type returns the prefix as a QName where the prefix is the local-part. An unprefixed namespace node returns None.

fn to_qname(&self, name: impl AsRef<str>) -> Result<QName, Error>

Resolve a name using the in-scope namespace declarations in the document, resulting in a Qualified Name. This will fail if the name is not a QName, or has a prefix that is unknown.

fn to_prefixed_name(&self) -> String

Convert the node’s qualified name to a prefixed name using the in-scope namespace declarations in the document.

fn to_namespace_prefix( &self, nsuri: &NamespaceUri, ) -> Result<Option<NamespacePrefix>, Error>

Find the prefix for the given namespace URI using the node’s in-scope namespaces. If the namespace is the default, then None is returned. If the namespace URI is not found in the in-scope namespaces returns an error.

fn to_namespace_uri( &self, prefix: &Option<NamespacePrefix>, ) -> Result<NamespaceUri, Error>

Find the namespace URI for the given namespace prefix using the node’s in-scope namespaces. If the namespace prefix is not found in the in-scope namespaces returns an error.

fn as_namespace_prefix(&self) -> Result<Option<&NamespacePrefix>, Error>

For a namespace node give the prefix. If the namespace is the default namespace, then None is given. If the node is not a namespace-type node then returns an error.

fn as_namespace_uri(&self) -> Result<&NamespaceUri, Error>

For a namespace node give the namespace URI. If the node is not a namespace-type node then returns an error.

fn is_in_scope(&self) -> bool

Is this namespace in scope, or is it a descoping declaration? See Namespaces in XML v1.1 s6.1. This only applies to Namespace-type nodes. All other node types return false.

fn value(&self) -> Rc<Value>

Get the value of the node. If the node doesn’t have a value, then returns a Value that is an empty string. If the node is a namespace-type node, gives the namespace URI.

fn get_id(&self) -> String

Get a unique identifier for this node.

fn to_string(&self) -> String

Get the string value of the node. See XPath ???

fn to_xml(&self) -> String

Serialise the node as XML

fn to_xml_with_options(&self, od: &OutputDefinition) -> String

Serialise the node as XML, with options such as indentation.

fn is_same(&self, other: &Self) -> bool

Check if two Nodes are the same Node

fn is_attached(&self) -> bool

fn document_order(&self) -> Vec<usize>

Get the document order of the node. The value returned is relative to the document containing the node. Depending on the implementation, this value may be volatile; adding or removing nodes to/from the document may invalidate the ordering.

fn owner_document(&self) -> Self

Get the document node

fn cmp_document_order(&self, other: &Self) -> Ordering

Compare the document order of this node with another node in the same document.

fn child_iter(&self) -> Self::NodeIterator

An iterator over the children of the node

fn ancestor_iter(&self) -> Self::NodeIterator

An iterator over the ancestors of the node

fn descend_iter(&self) -> Self::NodeIterator

An iterator over the descendants of the node

fn next_iter(&self) -> Self::NodeIterator

An iterator over the following siblings of the node

fn prev_iter(&self) -> Self::NodeIterator

An iterator over the preceding siblings of the node

fn attribute_iter(&self) -> Self::NodeIterator

An iterator over the attributes of an element

fn get_attribute(&self, a: &QName) -> Rc<Value>

Get an attribute of the node. Returns a copy of the attribute’s value. If the node does not have an attribute of the given name, a value containing an empty string is returned.

fn get_attribute_node(&self, a: &QName) -> Option<Self>

Get an attribute of the node. If the node is not an element returns None. Otherwise returns the attribute node. If the node does not have an attribute of the given name, returns None.

fn new_element(&self, qn: QName) -> Result<Self, Error>

Create a new element-type node in the same document tree. The new node is not attached to the tree.

fn new_namespace( &self, ns: NamespaceUri, prefix: Option<NamespacePrefix>, in_scope: bool, ) -> Result<Self, Error>

Create a namespace node for an XML Namespace declaration. A namespace may be descoped (see Namespace in XML v1.1). In this case, the prefix and namespace URI are given for the namespace being descoped, but with the in_scope argument ‘false’.

fn new_text(&self, v: Rc<Value>) -> Result<Self, Error>

Create a new text-type node in the same document tree. The new node is not attached to the tree.

fn new_attribute(&self, qn: QName, v: Rc<Value>) -> Result<Self, Error>

Create a new attribute-type node in the same document tree. The new node is not attached to the tree.

fn new_comment(&self, v: Rc<Value>) -> Result<Self, Error>

Create a new comment-type node in the same document tree. The new node is not attached to the tree.

fn new_processing_instruction( &self, qn: Rc<Value>, v: Rc<Value>, ) -> Result<Self, Error>

Create a new processing-instruction-type node in the same document tree. The new node is not attached to the tree.

fn push(&mut self, n: Self) -> Result<(), Error>

Append a node to the child list

fn pop(&mut self) -> Result<(), Error>

Remove a node from the tree

fn add_attribute(&self, att: Self) -> Result<(), Error>

Set an attribute. self must be an element-type node. att must be an attribute-type node. Returns an error if an attribute with the same name is already attached to this element.

fn insert_before(&mut self, n: Self) -> Result<(), Error>

Insert a node in the child list before the given node. The node will be detached from it’s current position prior to insertion.

fn shallow_copy(&self) -> Result<Self, Error>

Shallow copy the node, i.e. copy only the node, but not it’s attributes or content.

fn deep_copy(&self) -> Result<Self, Error>

Deep copy the node, i.e. the node itself and it’s attributes and descendants. The resulting top-level node is unattached.

fn get_canonical(&self) -> Result<Self, Error>

Canonical XML representation of the node.

fn set_xmldecl(&mut self, decl: XMLDecl) -> Result<(), Error>

Set the XML Declaration for the document.

fn xmldecl(&self) -> XMLDecl

Get the XML Declaration for the document.

fn is_id(&self) -> bool

Check if a node is an XML ID

fn is_idrefs(&self) -> bool

Check if a node is an XML IDREF or IDREFS

fn get_dtd(&self) -> Option<DTD>

Retrieve the internal representation of the DTD, for use in validation functions.

fn set_dtd(&self, dtd: DTD) -> Result<(), Error>

Store an internal representation of the DTD. Does not keep a copy of the original text

fn validate(&self, sch: Schema) -> Result<(), ValidationError>

fn to_json(&self) -> String

Serialise the node as JSON

fn is_element(&self) -> bool

Check if a node is an element-type

fn first_child(&self) -> Option<Self>

where Self: Sized,

Get the first child of the node, if there is one

fn parent(&self) -> Option<Self>

where Self: Sized,

Get the parent of the node. Top-level nodes do not have parents, also nodes that have been detached from the tree.

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

Compare two trees. If a non-document node is used, then the descendant subtrees are compared.