Struct Node

pub struct Node { /* private fields */ }

Contains information about opening and corresponding closing tags. It also can contain the value of the text between opening and closing tags if there are no children. Otherwise, if there are children mixed with text then each text chunk is separated in it’s own node with other children in order they appear in the code.

Implementations

impl Node

pub fn new() -> Self

Create new empty node with no children nor tags.

pub fn from_html( html: &str, settings: &LoadSettings, ) -> Result<Option<Node>, Error>

Load node tree from HTML string.

The root node has no start, end or text elements. It does have only children in it. When passing empty code, None will be returned. If there is an error parsing the HTML, then this function will fail and return the error type that occurred.

pub fn from_html_first(html: &str, settings: &LoadSettings) -> Option<Self>

Load the first node from HTML string without wrapping node to the tree with root (empty first node). Just return the exact single node.

Failures

None is returned if string does not contain any node (is empty).

pub fn start(&self) -> &Option<OpeningTag>

Start tag information.

pub fn end(&self) -> Option<&str>

End tag information.

pub fn text(&self) -> Option<&str>

Text that appears between opening and closing tags.

pub fn children(&self) -> &Children

Children tags of this node.

pub fn tag_name(&self) -> Option<&str>

The name of the tag that is represented by the node.

pub fn attributes(&self) -> Option<&Vec<Attribute>>

Start tag attributes.

pub fn attribute_by_name(&self, key: &str) -> Option<&Attribute>

Find attribute by it’s name.

pub fn put_attribute(&mut self, attr: Attribute) -> Result<(), Attribute>

Try saving given attribute in this node.

Failure

If this attribute is already present then this function will not change it. If you need to overwrite the attribute anyway use [overwrite_attribute].

pub fn overwrite_attribute(&mut self, attr: Attribute)

Save this attribute in the node. If it is already present then overwrite it.

pub fn children_fetch(&self) -> ChildrenFetch<'_>

Get children fetcher for this node to find children that apply to some criteria.

pub fn children_fetch_mut(&mut self) -> ChildrenFetchMut<'_>

pub fn to_string(&self) -> String

Convert this node and all it’s children into HTML string.

pub fn change_name(&mut self, name: &str)

Change name of opening and closing tags (if any).

pub fn change_opening_name(&mut self, name: &str)

Change the name of only opening tag if it exists.

pub fn change_closing_name(&mut self, name: &str)

Change the name of only closing tag if it exists.

pub fn children_mut(&mut self) -> &mut Children

Mutable access to array of node’s children.

pub fn clone_without_children(&self) -> Self

Clone this node without cloning children leaving new node with empty children list.

pub fn wrap_to_root(self) -> Result<Self, Self>

Try wrapping this node into root. This makes it possible to use this node as individual tree.

It is required for trees to start with empty node only with children. Many functions rely on this rule. For example, Fetch functions filter data only in children ignoring parent attributes and data.

Failures

If this node already is root it is returned back in Err.

pub fn is_root(&self) -> bool

Check whether this node is the root of the tree.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Default for Node

fn default() -> Node

Returns the “default value” for a type.

impl From<Node> for NodeAccess

fn from(node: Node) -> Self

Converts to this type from the input type.

impl PartialEq for Node

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Node