Struct tui_realm_treeview::Node

pub struct Node { /* fields omitted */ }

Node

Describes a node inside the Tree

Implementations

impl Node

pub fn new<S: AsRef<str>>(id: S, label: S) -> Self

new

Instantiates a new Node ATTENTION: id mustn’t be empty nor duplicated

pub fn id(&self) -> &str

id

Get reference to id

pub fn label(&self) -> &str

label

Get reference to label

pub fn with_children(self, children: Vec<Node>) -> Self

with_children

Sets Node children

pub fn with_child(self, child: Node) -> Self

with_child

Create a new child in this Node

pub fn add_child(&mut self, child: Node)

add_child

Add a child to the node

pub fn clear(&mut self)

clear

Clear node children

pub fn truncate(&mut self, depth: usize)

truncate

Truncate tree at depth. If depth is 0, node’s children will be cleared

pub fn is_leaf(&self) -> bool

is_leaf

Returns whether this node is a leaf (which means it has no children)

pub fn query(&self, id: &str) -> Option<&Self>

query

Search for id inside Node’s children (or is itself)

pub fn count(&self) -> usize

count

Count items in tree

pub fn depth(&self) -> usize

depth

Calculate the maximum depth of the tree

pub fn parent(&self, id: &str) -> Option<&Self>

parent

Get parent node of id

pub fn siblings(&self, id: &str) -> Option<Vec<&str>>

siblings

Get siblings for provided node

pub fn node_by_route(&self, route: &[usize]) -> Option<&Self>

node_by_route

Given a vector of indexes, returns the node associated to the route

pub fn route_by_node(&self, id: &str) -> Option<Vec<usize>>

route_by_node

Calculate the route of a node by its id

Trait Implementations

impl Debug for Node

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

Formats the value using the given formatter.