Trait xml_dom::level2::Node

pub trait Node {
    type NodeRef;
    fn node_name(&self) -> Name;
    fn node_value(&self) -> Option<String>;
    fn set_node_value(&mut self, value: &str) -> Result<()>;
    fn unset_node_value(&mut self) -> Result<()>;
    fn node_type(&self) -> NodeType;
    fn parent_node(&self) -> Option<Self::NodeRef>;
    fn child_nodes(&self) -> Vec<Self::NodeRef>;
    fn first_child(&self) -> Option<Self::NodeRef>;
    fn last_child(&self) -> Option<Self::NodeRef>;
    fn previous_sibling(&self) -> Option<Self::NodeRef>;
    fn next_sibling(&self) -> Option<Self::NodeRef>;
    fn attributes(&self) -> HashMap<Name, Self::NodeRef>;
    fn owner_document(&self) -> Option<Self::NodeRef>;
    fn insert_before(
        &mut self, 
        new_child: Self::NodeRef, 
        ref_child: Option<Self::NodeRef>
    ) -> Result<Self::NodeRef>;
    fn replace_child(
        &mut self, 
        new_child: Self::NodeRef, 
        old_child: Self::NodeRef
    ) -> Result<Self::NodeRef>;
    fn remove_child(
        &mut self, 
        old_child: Self::NodeRef
    ) -> Result<Self::NodeRef>;
    fn append_child(
        &mut self, 
        new_child: Self::NodeRef
    ) -> Result<Self::NodeRef>;
    fn has_child_nodes(&self) -> bool;
    fn clone_node(&self, deep: bool) -> Option<Self::NodeRef>;
    fn normalize(&mut self);
    fn is_supported(&self, feature: &str, version: &str) -> bool;
    fn has_attributes(&self) -> bool;

    fn namespace_uri(&self) -> Option<String> { ... }
    fn local_name(&self) -> String { ... }
    fn prefix(&self) -> Option<String> { ... }
}

This corresponds to the DOM Node interface.

Specification

The Node interface is the primary datatype for the entire Document Object Model. It represents a single node in the document tree. While all objects implementing the Node interface expose methods for dealing with children, not all objects implementing the Node interface may have children. For example, Text nodes may not have children, and adding children to such nodes results in a DOMException being raised.

The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specific nodeType (e.g., nodeValue for an Element or attributes for a Comment), this returns null. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.

The values of nodeName, nodeValue, and attributes vary according to the node type as follows:

Interface	nodeName	nodeValue	attributes
Attr	name of attribute	value of attribute	None
CDATASection	"#cdata-section"	content of the CDATA Section	None
Comment	"#comment"	content of the comment	None
Document	"#document"	None	None
DocumentFragment	"#document-fragment"	None	None
DocumentType	document type name	None	None
Element	tag name	None	HashMap
Entity	entity name	None	None
EntityReference	name of entity referenced	None	None
Notation	notation name	None	None
ProcessingInstruction	target	entire content excluding the target	None
Text	"#text"	content of the text node	None

Associated Types

type NodeRef

The opaque reference type that wraps the implementation of a node within the DOM.

Loading content...

Required methods

fn node_name(&self) -> Name

The name of this node, depending on its type; see the table above.

fn node_value(&self) -> Option<String>

The value of this node, depending on its type; see the table above. When it is defined to be None, setting it has no effect.

Specification

Exceptions on setting

• NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Exceptions on retrieval

• DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

fn set_node_value(&mut self, value: &str) -> Result<()>

Set the value for the node; see node_value.

fn unset_node_value(&mut self) -> Result<()>

Set the value for the node to None; see node_value.

fn node_type(&self) -> NodeType

A code representing the type of the underlying object.

fn parent_node(&self) -> Option<Self::NodeRef>

The parent of this node. All nodes, except Attr, Document, DocumentFragment, Entity, and Notation may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is None.

fn child_nodes(&self) -> Vec<Self::NodeRef>

A Vec that contains all children of this node. If there are no children, this is a Vec containing no nodes.

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

The first child of this node. If there is no such node, this returns None.

fn last_child(&self) -> Option<Self::NodeRef>

The last child of this node. If there is no such node, this returns None.

fn previous_sibling(&self) -> Option<Self::NodeRef>

The node immediately preceding this node. If there is no such node, this returns None.

fn next_sibling(&self) -> Option<Self::NodeRef>

The node immediately following this node. If there is no such node, this returns None.

fn attributes(&self) -> HashMap<Name, Self::NodeRef>

A HashMap containing the attributes of this node (if it is an Element) or None otherwise.

fn owner_document(&self) -> Option<Self::NodeRef>

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is None.

fn insert_before(
    &mut self,
    new_child: Self::NodeRef,
    ref_child: Option<Self::NodeRef>
) -> Result<Self::NodeRef>

Inserts the node newChild before the existing child node refChild.

Specification

If refChild is null, insert newChild at the end of the list of children.

If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.

Parameters

• newChild of type Node: The node to insert.
• refChild of type Node: The reference node, i.e., the node before which the new node must be inserted.

Return Value

• Node: The node being inserted.

Exceptions

• HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors.
• WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
• NOT_FOUND_ERR: Raised if refChild is not a child of this node.

fn replace_child(
    &mut self,
    new_child: Self::NodeRef,
    old_child: Self::NodeRef
) -> Result<Self::NodeRef>

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

Specification

If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.

Parameters

• newChild of type Node: The new node to put in the child list.
• oldChild of type Node: The node being replaced in the list.

Return Value

• Node: The node replaced.

Exceptions

• HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors.
• WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
• NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

fn remove_child(&mut self, old_child: Self::NodeRef) -> Result<Self::NodeRef>

Removes the child node indicated by oldChild from the list of children, and returns it.

Specification

Parameters

• oldChild of type Node: The node being removed.

Return Value

• Node: The node removed.

Exceptions

• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
• NOT_FOUND_ERR: Raised if oldChild is not a child of this node.

fn append_child(&mut self, new_child: Self::NodeRef) -> Result<Self::NodeRef>

Adds the node newChild to the end of the list of children of this node.

Specification

If the newChild is already in the tree, it is first removed.

Parameters

• newChild of type Node: The node to add. If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node.

Return Value

Node: The node added.

Exceptions

• HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors.
• WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

fn has_child_nodes(&self) -> bool

Returns whether this node has any children.

Specification

Return Value

• boolean: true if this node has any children, false otherwise.

fn clone_node(&self, deep: bool) -> Option<Self::NodeRef>

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

Note: currently unsupported.

Specification

The duplicate node has no parent; (parentNode is null.).

Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning any other type of node simply returns a copy of this node.

Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly. In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.

Parameters

• deep of type boolean: If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).

Return Value

• Node:The duplicate node.

fn normalize(&mut self)

Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.

Specification

This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.

Note: In cases where the document contains CDataSection, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.

fn is_supported(&self, feature: &str, version: &str) -> bool

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

Note: currently unsupported.

Specification

Parameters

• feature of type DOMString: The name of the feature to test. This is the same name which can be passed to the method hasFeature on DOMImplementation.
• version of type DOMString: This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.

Return Value

• boolean: Returns true if the specified feature is supported on this node, false otherwise.

fn has_attributes(&self) -> bool

Returns whether this node (if it is an element) has any attributes.

Return Value

• boolean: true if this node has any attributes, false otherwise.

Loading content...

Provided methods

fn namespace_uri(&self) -> Option<String>

The namespace URI of this node, or null if it is unspecified.

Specification

This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Note: Per the Namespaces in XML Specification an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace.

fn local_name(&self) -> String

Returns the local part of the qualified name of this node.

Specification

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

fn prefix(&self) -> Option<String>

The namespace prefix of this node, or null if it is unspecified.

Specification

Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.

Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespaceURI and localName do not change.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Exceptions

• INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
• NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
• NAMESPACE_ERR: Raised if the specified prefix is malformed, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from "http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from
  "http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns".

Loading content...

Implementors

impl Node for RefNode

type NodeRef = RefNode

fn node_name(&self) -> Name

fn node_value(&self) -> Option<String>

fn set_node_value(&mut self, value: &str) -> Result<()>

fn unset_node_value(&mut self) -> Result<()>

fn node_type(&self) -> NodeType

fn parent_node(&self) -> Option<RefNode>

fn child_nodes(&self) -> Vec<RefNode>

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

fn last_child(&self) -> Option<RefNode>

fn previous_sibling(&self) -> Option<RefNode>

fn next_sibling(&self) -> Option<RefNode>

fn attributes(&self) -> HashMap<Name, RefNode, RandomState>

fn owner_document(&self) -> Option<RefNode>

fn insert_before(
    &mut self,
    new_child: RefNode,
    ref_child: Option<RefNode>
) -> Result<RefNode>

fn replace_child(
    &mut self,
    new_child: RefNode,
    old_child: RefNode
) -> Result<RefNode>

fn remove_child(&mut self, old_child: Self::NodeRef) -> Result<Self::NodeRef>

fn append_child(&mut self, new_child: RefNode) -> Result<RefNode>

fn has_child_nodes(&self) -> bool

fn clone_node(&self, deep: bool) -> Option<RefNode>

fn normalize(&mut self)

fn is_supported(&self, feature: &str, version: &str) -> bool

fn has_attributes(&self) -> bool

Loading content...