Struct tl::NodeHandle

pub struct NodeHandle(/* private fields */);

A detached, external handle to a HTML node, originally obtained from a Parser

It contains an identifier that uniquely identifies an HTML node. In particular, it is an index into the global HTML tag table managed by the Parser. To get a Node out of a NodeHandle, call NodeHandle::get()

A common way to model self referential/recursive graphs is to have one “global” vector of nodes, and store indices into the vector instead of references. In the case of tl, the “global” HTML tag vector is stored in the Parser and NodeHandle represents the index. Because NodeHandle is only an index and completely detached from anything, you need to pass a parser to NodeHandle::get()

Implementations

impl NodeHandle

pub fn new(node: InnerNodeHandle) -> Self

Creates a new handle to the given node

pub fn get<'p, 'buf>(&self, parser: &'p Parser<'buf>) -> Option<&'p Node<'buf>>

Returns a reference to the node that is associated to this specific handle

It is an error to pass in the wrong parser. It will either return None if this index points outside of the nodes table, or it will return the one it points to.

pub fn get_mut<'p, 'buf>( &self, parser: &'p mut Parser<'buf> ) -> Option<&'p mut Node<'buf>>

Returns a mutable reference to the node that is associated to this specific handle

It is an error to pass in the wrong parser. It will either return None if this index points outside of the nodes table, or it will return the one it points to.

pub fn get_inner(&self) -> InnerNodeHandle

Returns the internal unique Node ID that maps to a specific node in the node table

Trait Implementations

impl Clone for NodeHandle

fn clone(&self) -> NodeHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeHandle

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

Formats the value using the given formatter.

impl Hash for NodeHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for NodeHandle

fn cmp(&self, other: &NodeHandle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NodeHandle

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for NodeHandle

fn partial_cmp(&self, other: &NodeHandle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for NodeHandle

impl Eq for NodeHandle

impl StructuralPartialEq for NodeHandle