Struct promkit::tree::Tree

pub struct Tree { /* private fields */ }

A Tree structure that manages a collection of nodes in a hierarchical manner. It utilizes a cursor to navigate and manipulate the nodes within the tree.

Implementations

impl Tree

pub fn new(root: Node) -> Self

Creates a new Tree with a given root node.

Arguments

• root - The root node of the tree.

pub fn kinds(&self) -> Vec<Kind>

Returns a vector of all nodes in the tree, represented with their depth information.

pub fn position(&self) -> usize

Returns the current position of the cursor within the tree.

pub fn get(&self) -> Vec<String>

Retrieves the data of the current node pointed by the cursor, along with its path from the root.

pub fn toggle(&mut self)

Toggles the state of the current node and updates the cursor position accordingly.

pub fn backward(&mut self) -> bool

Moves the cursor backward in the tree, if possible.

Returns true if the cursor was successfully moved backward, false otherwise.

pub fn forward(&mut self) -> bool

Moves the cursor forward in the tree, if possible.

Returns true if the cursor was successfully moved forward, false otherwise.

pub fn move_to_head(&mut self)

Moves the cursor to the head of the tree.

pub fn move_to_tail(&mut self)

Moves the cursor to the tail of the tree.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value.

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

Performs copy-assignment from source.