Enum Node 

pub enum Node {
    NonLeaf {
        id: String,
        children: Vec<Node>,
        children_visible: bool,
    },
    Leaf(String),
}

Available on crate feature tree only.

Represents a node within a tree structure.

A node can either be a NonLeaf, containing children and a visibility flag, or a Leaf, representing an end node without children.

Variants

NonLeaf

Represents a non-leaf node, which can contain child nodes.

• id: A unique identifier for the node.
• children: A vector of child nodes.
• children_visible: A boolean indicating if the children of this node are visible.

Fields

id: String

children: Vec<Node>

children_visible: bool

Leaf(String)

Represents a leaf node, which does not contain any child nodes.

• id: A unique identifier for the leaf node.

Implementations

impl Node

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

Flattens the tree structure into a vector of Kind, including only visible nodes.

This method performs a depth-first search (DFS) to traverse the tree and collect nodes into a vector. Each node is represented as either Kind::Folded or Kind::Unfolded based on its visibility and whether it has children.

Returns:

• Vec: A vector of Kind representing the visible nodes in the tree.

pub fn toggle(&mut self, path: &Path)

Toggles the visibility of the children of the node specified by the given path.

Parameters:

• path: &Path - A reference to a vector of usize, representing the path to the target node.

This method modifies the tree in-place. If the target node is found and is a NonLeaf, its children_visible field is toggled.

pub fn get_waypoints(&self, path: &Path) -> Vec<String>

Retrieves the IDs of all nodes along the path to a specified node.

Parameters:

• path: &Path - A reference to a vector of usize, representing the path to the target node.

Returns:

• Vec: A vector of String IDs representing the nodes along the path to the target node.

pub fn get(&self, path: &Path) -> Option<&Node>

Retrieves a reference to the node specified by the given path.

Parameters:

• path: &Path - A reference to a vector of usize, representing the path to the target node.

Returns:

• Option<&Node>: An option containing a reference to the target node if found, or None otherwise.

pub fn get_mut(&mut self, path: &Path) -> Option<&mut Node>

Retrieves a mutable reference to the node specified by the given path.

Parameters:

• path: &Path - A reference to a vector of usize, representing the path to the target node.

Returns:

• Option<&mut Node>: An option containing a mutable reference to the target node if found, or None otherwise.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl PartialEq for Node

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&PathBuf> for Node

type Error = Error

Attempts to create a Node from a given directory path.

This method constructs a Node::NonLeaf representing the directory specified by dir_path. It recursively explores the directory, converting subdirectories into Node::NonLeaf instances and files into Node::Leaf instances. Directories and files are kept in separate lists initially, then combined with all directories first, followed by files. Both lists are sorted alphabetically before merging. The resulting tree structure reflects the hierarchy of files and directories within dir_path, with directories listed before files, both in alphabetical order.

Parameters

• dir_path: A reference to a PathBuf representing the directory to be converted into a Node.

Returns

A Result containing the root Node of the constructed tree if successful, or an Error if the directory cannot be read or if any file name cannot be converted to a string.

Errors

This method returns an Error if:

• The path does not exist or is not a directory.
• There is an error reading the directory contents.
• A file name cannot be converted to a UTF-8 string.

fn try_from(dir_path: &PathBuf) -> Result<Self>

Performs the conversion.

impl Eq for Node

impl StructuralPartialEq for Node