Struct TreeRef

pub struct TreeRef<'a, 'b> {
    pub id: TreeRefId,
    pub tree: &'b Tree<'a>,
}

A reference to a node in the tree.

Fields

id: TreeRefId

A unique ID identifying the node in the tree.

tree: &'b Tree<'a>

The tree owning this node.

Implementations

impl<'a, 'b> TreeRef<'a, 'b>

pub fn id(&self) -> TreeRefId

pub fn spanned_data(&self) -> &ParsedNode<'a>

Get an immutable reference to the underlying ParsedNode containing the Node and the location of the span of text where it was defined.

Panics

Panics if the node does not exist in the tree (it could have been removed).

pub fn data(&self) -> &Node<'a>

Get an immutable reference to the underlying Node.

Panics

Panics if the node does not exist in the tree (it could have been removed).

pub fn parent(&self) -> Self

Get a reference to the parent of this node.

pub fn closest(&self, selector: &str) -> Option<Self>

Search all parents of the node until it finds a node matching the provided CSS selector.

Returns None if the selector is invalid or if a node matching the selector could not be found.

This method is equivalent to the Element.closest method in Javascript.

pub fn prev_sibling(&self) -> Option<Self>

Get a reference to the previous sibling of this node.

pub fn next_sibling(&self) -> Option<Self>

Get a reference to the next sibling of this node.

pub fn children<'c>(&'c self) -> impl Iterator<Item = TreeRef<'a, 'b>> + 'c

Get a list of references of the children of this node.

pub fn children_id(&self) -> Vec<TreeRefId>

Get a cloned list of IDs of this node children.

pub fn select<'c>( &self, selector: &'c str, ) -> Result<Option<TreeRef<'_, '_>>, SelectorParseError<'c>>

Search the first node matching the CSS selector in the tree, relatively to this node.

The traversal order used is the same as in the official DOM specification ie preorder, depth-first.

It is similar to the document.querySelector function in JavaScript.

Errors

Returns selectors::parser::SelectorParseError if the CSS selector is not a valid CSS selector or Ok(None) if no node matching the CSS selector is found in the tree

pub fn select_all(&self, selector: &str) -> Vec<TreeRef<'_, '_>>

Select several nodes in the tree, relatively to this node, using a CSS selector.

It is similar to the document.querySelectorAll function in JavaScript.

Returns an empty Vec if the selector is not a valid CSS selector.

pub fn name(&self) -> Result<Cow<'a, str>>

Get the element name of the TreeRef.

Errors

Returns Error::BadNodeType if the underlying node is not a Node::Element.

pub fn text(&self) -> Cow<'a, str>

Get the text of the TreeRef.

Returns the concatenated text content of child nodes if it is a Node::Element.

Returns the text content if it is a Node::TemplateBlock(TemplateBlock::RawText(_)).

All template expressions and statements just return their raw content with no spaces inside their delimiters (will return {{expr}} even if it was {{ expr }}, {!expr!} event if it was {! expr !} and {%stmt%} even if it was {% stmt %}).

pub fn attr(&self, name: &str) -> Result<Option<String>>

Get the value of an attribute belonging to a Node::Element.

All template expressions and statements just return their raw content with no spaces inside their delimiters (will return {{expr}} even if it was {{ expr }}, {!expr!} event if it was {! expr !} and {%stmt%} even if it was {% stmt %}).

Errors

Returns Error::BadNodeType if the underlying node is not a Node::Element.

Returns None if the attribute is not present.

Returns Some("") if the attribute is present but does not have a value (e.g. in <input type="checkbox" checked>, the checked HTML attribute is present but does not have a value).

Returns Some(value) if the attribute is present and does have a value.

pub fn attr_spanned( &self, name: &str, ) -> Result<Option<Vec<Spanned<TemplateBlock<'_>>>>>

Get the value of an attribute belonging to a Node::Element.

Template expressions and statements can be returned.

Errors

Returns Error::BadNodeType if the underlying node is not a Node::Element.

Returns None if the attribute is not present.

pub fn attrs(&self) -> Result<impl Iterator<Item = (&Cow<'_, str>, String)>>

Get all attributes belonging to a Node::Element.

All template expressions and statements just return their raw content with no spaces inside their delimiters (will return {{expr}} even if it was {{ expr }}, {!expr!} event if it was {! expr !} and {%stmt%} even if it was {% stmt %}).

An empty attribute value means that an attribute key was given without a value. See TreeRef::attr for more information.

Errors

Returns Error::BadNodeType if the underlying node is not a Node::Element.

pub fn attrs_spanned(&self) -> Result<impl Iterator<Item = &Attr<'_>>>

Get all attributes belonging to a Node::Element.

Template expressions and statements can be returned.

Errors

Returns Error::BadNodeType if the underlying node is not a Node::Element.

pub fn sub_tree(&self) -> Tree<'a>

pub fn traverse_breadth(&self) -> impl Iterator<Item = TreeRef<'a, '_>>

pub fn traverse_depth(&self) -> impl Iterator<Item = TreeRef<'a, '_>>

pub fn is_matching(&self, selector_list: &SelectorList<InnerSelector>) -> bool

Trait Implementations

impl<'a, 'b> Clone for TreeRef<'a, 'b>

fn clone(&self) -> TreeRef<'a, 'b>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreeRef<'_, '_>

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

Formats the value using the given formatter.

impl Element for TreeRef<'_, '_>

type Impl = InnerSelector

fn opaque(&self) -> OpaqueElement

Converts self into an opaque representation.

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

fn parent_node_is_shadow_root(&self) -> bool

Whether the parent node of this element is a shadow root.

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

The host of the containing shadow root, if any.

fn is_pseudo_element(&self) -> bool

Whether we’re matching on a pseudo-element.

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

Skips non-element nodes

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

Skips non-element nodes

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

Skips non-element nodes

fn is_html_element_in_html_document(&self) -> bool

fn has_local_name( &self, local_name: &<Self::Impl as SelectorImpl>::BorrowedLocalName, ) -> bool

fn has_namespace( &self, _ns: &<Self::Impl as SelectorImpl>::BorrowedNamespaceUrl, ) -> bool

Empty string for no namespace

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

Whether this element and the other element have the same local name and namespace.

fn attr_matches( &self, _ns: &NamespaceConstraint<&<Self::Impl as SelectorImpl>::NamespaceUrl>, local_name: &<Self::Impl as SelectorImpl>::LocalName, operation: &AttrSelectorOperation<&<Self::Impl as SelectorImpl>::AttrValue>, ) -> bool

fn match_non_ts_pseudo_class( &self, _pc: &<Self::Impl as SelectorImpl>::NonTSPseudoClass, _context: &mut MatchingContext<'_, Self::Impl>, ) -> bool

fn match_pseudo_element( &self, _pe: &<Self::Impl as SelectorImpl>::PseudoElement, _context: &mut MatchingContext<'_, Self::Impl>, ) -> bool

fn apply_selector_flags(&self, _flags: ElementSelectorFlags)

Sets selector flags on the elemnt itself or the parent, depending on the flags, which indicate what kind of work may need to be performed when DOM state changes.

fn is_link(&self) -> bool

Whether this element is a link.

fn is_html_slot_element(&self) -> bool

Returns whether the element is an HTML element.

fn has_id( &self, id: &<Self::Impl as SelectorImpl>::Identifier, case_sensitivity: CaseSensitivity, ) -> bool

fn has_class( &self, name: &<Self::Impl as SelectorImpl>::Identifier, case_sensitivity: CaseSensitivity, ) -> bool

fn imported_part( &self, _name: &<Self::Impl as SelectorImpl>::Identifier, ) -> Option<<Self::Impl as SelectorImpl>::Identifier>

Returns the mapping from the exportparts attribute in the reverse direction, that is, in an outer-tree -> inner-tree direction.

fn is_part(&self, _name: &<Self::Impl as SelectorImpl>::Identifier) -> bool

fn is_empty(&self) -> bool

Returns whether this element matches :empty.

fn is_root(&self) -> bool

Returns whether this element matches :root, i.e. whether it is the root element of a document.

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

Returns the assigned element this element is assigned to.

fn ignores_nth_child_selectors(&self) -> bool

Returns whether this element should ignore matching nth child selector.

fn has_custom_state( &self, _name: &<Self::Impl as SelectorImpl>::Identifier, ) -> bool

fn add_element_unique_hashes(&self, _filter: &mut BloomFilter) -> bool

Add hashes unique to this element to the given filter, returning true if any got added.

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

The parent of a given pseudo-element, after matching a pseudo-element selector.

fn has_attr_in_no_namespace( &self, local_name: &<Self::Impl as SelectorImpl>::LocalName, ) -> bool

impl PartialEq for TreeRef<'_, '_>

fn eq(&self, other: &Self) -> 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<'a, 'b> Copy for TreeRef<'a, 'b>