Struct ElementRef

pub struct ElementRef { /* private fields */ }

Wrapper around a reference to an element node.

This wrapper implements the Element trait from the selectors crate, which allows it to be matched against CSS selectors.

Implementations

impl ElementRef

pub fn wrap(node: NodeRef<Node>) -> Option<Self>

Wraps a NodeRef only if it references a Node::Element.

pub fn map_value<F, R>(&self, map_fn: F) -> Option<R>

where F: FnOnce(&Element) -> R,

Maps a function to the Element referenced by self.

pub fn select(&self, selector: Selector) -> Select

Returns an iterator over descendent elements matching a selector.

pub fn html(&self) -> String

Returns the HTML of this element.

pub fn inner_html(&self) -> String

Returns the inner HTML of this element.

pub fn text(&self) -> Text

Returns an iterator over descendent text nodes.

pub fn inner_text(&self) -> String

Returns all the descendent text nodes content concatenated.

Methods from Deref<Target = NodeRef<Node>>

pub fn ancestors(&self) -> Ancestors<T>

Returns an iterator over ancestors.

pub fn prev_siblings(&self) -> PrevSiblings<T>

Returns an iterator over previous siblings.

pub fn next_siblings(&self) -> NextSiblings<T>

Returns an iterator over next siblings.

pub fn first_children(&self) -> FirstChildren<T>

Returns an iterator over first children.

pub fn last_children(&self) -> LastChildren<T>

Returns an iterator over last children.

pub fn children(&self) -> Children<T>

Returns an iterator over children.

pub fn traverse(&self) -> Traverse<T>

Returns an iterator which traverses the subtree starting at this node.

pub fn descendants(&self) -> Descendants<T>

Returns an iterator over this node and its descendants.

pub fn id(&self) -> NodeId

Returns the ID of this node.

pub fn map_value<F, R>(&self, map_fn: F) -> Option<R>

where F: FnOnce(&T) -> R,

Returns the result of map_fn applied to the value of this node.

pub fn update_value<F>(&self, update_fn: F) -> bool

where F: FnOnce(&mut T),

Update the value of this node.

pub fn parent(&self) -> Option<NodeRef<T>>

Returns the parent of this node.

pub fn prev_sibling(&self) -> Option<NodeRef<T>>

Returns the previous sibling of this node.

pub fn next_sibling(&self) -> Option<NodeRef<T>>

Returns the next sibling of this node.

pub fn first_child(&self) -> Option<NodeRef<T>>

Returns the first child of this node.

pub fn last_child(&self) -> Option<NodeRef<T>>

Returns the last child of this node.

pub fn has_siblings(&self) -> bool

Returns true if this node has siblings.

pub fn has_children(&self) -> bool

Returns true if this node has children.

Trait Implementations

impl Clone for ElementRef

fn clone(&self) -> ElementRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ElementRef

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

Formats the value using the given formatter.

impl Deref for ElementRef

type Target = NodeRef<Node>

The resulting type after dereferencing.

fn deref(&self) -> &NodeRef<Node>

Dereferences the value.

impl Element for ElementRef

Note: will never match against non-tree-structure pseudo-classes.

type Impl = Simple

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 is_part(&self, _name: &CssLocalName) -> bool

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

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

fn imported_part(&self, _: &CssLocalName) -> Option<CssLocalName>

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

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, name: &CssLocalName) -> bool

fn has_namespace(&self, namespace: &Namespace) -> bool

Empty string for no namespace

fn attr_matches( &self, ns: &NamespaceConstraint<&Namespace>, local_name: &CssLocalName, operation: &AttrSelectorOperation<&CssString>, ) -> bool

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

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

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: &CssLocalName, case_sensitivity: CaseSensitivity) -> bool

fn has_class( &self, name: &CssLocalName, case_sensitivity: CaseSensitivity, ) -> 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 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 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

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.

impl PartialEq for ElementRef

fn eq(&self, other: &ElementRef) -> 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 Serialize for ElementRef

fn serialize<S>( &self, serializer: &mut S, traversal_scope: TraversalScope, ) -> Result<(), Error>

where S: Serializer,

Take the serializer and call its methods to serialize this type. The type will dictate which methods are called and with what parameters.

impl StructuralPartialEq for ElementRef