Struct azul_core::dom::NodeId

pub struct NodeId { /* fields omitted */ }

A node identifier within a particular Arena.

Implementations

impl NodeId

pub const ZERO: NodeId

pub fn new(value: usize) -> Self

NOTE: In debug mode, it panics on overflow, since having a pointer that is zero is undefined behaviour (it would basically be cast to a None), which is incorrect, so we rather panic on overflow to prevent that.

To trigger an overflow however, you'd need more that 4 billion DOM nodes - it is more likely that you run out of RAM before you do that. The only thing that could lead to an overflow would be a bug. Therefore, overflow-checking is disabled in release mode.

pub fn index(&self) -> usize

pub fn range(start: Self, end: Self) -> Vec<NodeId>

Return an iterator of references to this node’s children.

impl NodeId

pub const fn ancestors(self, node_hierarchy: &NodeHierarchy) -> Ancestors

Return an iterator of references to this node and its ancestors.

Call .next().unwrap() once on the iterator to skip the node itself.

pub const fn preceding_siblings(
    self,
    node_hierarchy: &NodeHierarchy
) -> PrecedingSiblings

Return an iterator of references to this node and the siblings before it.

Call .next().unwrap() once on the iterator to skip the node itself.

pub const fn following_siblings(
    self,
    node_hierarchy: &NodeHierarchy
) -> FollowingSiblings

Return an iterator of references to this node and the siblings after it.

Call .next().unwrap() once on the iterator to skip the node itself.

pub fn children(self, node_hierarchy: &NodeHierarchy) -> Children

Return an iterator of references to this node’s children.

pub fn reverse_children(self, node_hierarchy: &NodeHierarchy) -> ReverseChildren

Return an iterator of references to this node’s children, in reverse order.

pub const fn descendants(self, node_hierarchy: &NodeHierarchy) -> Descendants

Return an iterator of references to this node and its descendants, in tree order.

Parent nodes appear before the descendants. Call .next().unwrap() once on the iterator to skip the node itself.

pub const fn traverse(self, node_hierarchy: &NodeHierarchy) -> Traverse

Return an iterator of references to this node and its descendants, in tree order.

pub const fn reverse_traverse(
    self,
    node_hierarchy: &NodeHierarchy
) -> ReverseTraverse

Return an iterator of references to this node and its descendants, in tree order.

Trait Implementations

impl Add<usize> for NodeId

type Output = NodeId

The resulting type after applying the + operator.

fn add(self, other: usize) -> NodeId

Performs the + operation.

impl AddAssign<usize> for NodeId

fn add_assign(&mut self, other: usize)

Performs the += operation.

impl Clone for NodeId

fn clone(&self) -> NodeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for NodeId

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Display for NodeId

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

Formats the value using the given formatter.

impl Eq for NodeId

impl Hash for NodeId

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, 

Feeds a slice of this type into the given [Hasher].

impl Index<NodeId> for NodeHierarchy

type Output = Node

The returned type after indexing.

fn index(&self, node_id: NodeId) -> &Node

Performs the indexing (container[index]) operation.

impl<T> Index<NodeId> for NodeDataContainer<T>

type Output = T

The returned type after indexing.

fn index(&self, node_id: NodeId) -> &T

Performs the indexing (container[index]) operation.

impl IndexMut<NodeId> for NodeHierarchy

fn index_mut(&mut self, node_id: NodeId) -> &mut Node

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<NodeId> for NodeDataContainer<T>

fn index_mut(&mut self, node_id: NodeId) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl Ord for NodeId

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<NodeId> for NodeId

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

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

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

This method tests for !=.

impl PartialOrd<NodeId> for NodeId

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for NodeId

impl StructuralPartialEq for NodeId