Struct egui_dock::NodeIndex

pub struct NodeIndex(pub usize);

Wrapper around indices to the collection of nodes inside a Tree.

Tuple Fields

0: usize

Implementations

impl NodeIndex

pub const fn root() -> Self

Returns the index of the root node.

pub const fn left(self) -> Self

Returns the index of the node to the left of the current one.

pub const fn right(self) -> Self

Returns the index of the node to the right of the current one.

pub const fn parent(self) -> Option<Self>

Returns the index of the parent node or None if current node is the root.

pub const fn level(self) -> usize

Returns the number of nodes leading from the root to the current node, including self.

pub const fn is_left(self) -> bool

Returns true if current node is the left node of its parent, false otherwise.

pub const fn is_right(self) -> bool

Returns true if current node is the right node of its parent, false otherwise.

Trait Implementations

impl Clone for NodeIndex

fn clone(&self) -> NodeIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeIndex

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

Formats the value using the given formatter.

impl From<usize> for NodeIndex

fn from(index: usize) -> Self

Converts to this type from the input type.

impl Hash for NodeIndex

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<Tab> Index<NodeIndex> for Tree<Tab>

type Output = Node<Tab>

The returned type after indexing.

fn index(&self, index: NodeIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<Tab> IndexMut<NodeIndex> for Tree<Tab>

fn index_mut(&mut self, index: NodeIndex) -> &mut Self::Output

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

impl PartialEq<NodeIndex> for NodeIndex

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

impl Eq for NodeIndex

impl StructuralEq for NodeIndex

impl StructuralPartialEq for NodeIndex