Struct Leaf

pub struct Leaf { /* private fields */ }

A terminal node in the tree that contains a value but no children.

Leaf represents the simplest type of tree node - one that holds a string value and a visibility flag, but cannot have child nodes. This is useful for representing individual items in a tree structure.

Examples

use lipgloss_tree::{Leaf, Node, Children};

let leaf = Leaf::new("Hello, World!", false);
assert_eq!(leaf.value(), "Hello, World!");
assert!(!leaf.hidden());
assert_eq!(leaf.children().length(), 0);

println!("{}", leaf); // Outputs: Hello, World!

Implementations

impl Leaf

pub fn new(value: impl Into<String>, hidden: bool) -> Self

Creates a new leaf node with the given value and visibility.

Arguments

• value - The content for this leaf (anything convertible to String)
• hidden - Whether this leaf should be hidden from rendering

Examples

use lipgloss_tree::{Leaf, Node};

let visible_leaf = Leaf::new("Visible", false);
let hidden_leaf = Leaf::new("Hidden", true);

assert!(!visible_leaf.hidden());
assert!(hidden_leaf.hidden());

Trait Implementations

impl Clone for Leaf

fn clone(&self) -> Leaf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Leaf

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

Formats the value using the given formatter.

impl Display for Leaf

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

Formats the value using the given formatter.

impl From<Leaf> for Box<dyn Node>

fn from(leaf: Leaf) -> Self

Converts to this type from the input type.

impl Node for Leaf

fn value(&self) -> String

Returns the string value of this node.

fn children(&self) -> Box<dyn Children>

Returns the children of this node.

fn hidden(&self) -> bool

Returns whether this node is hidden from rendering.

fn set_hidden(&mut self, hidden: bool)

Sets the visibility state of this node.

fn set_value(&mut self, value: String)

Updates the value of this node.

fn get_enumerator(&self) -> Option<&Enumerator>

Returns the custom enumerator function for this node, if any.

fn get_indenter(&self) -> Option<&Indenter>

Returns the custom indenter function for this node, if any.

fn get_item_style(&self) -> Option<&Style>

Returns the base item style for this node, if any.

fn get_enumerator_style(&self) -> Option<&Style>

Returns the base enumerator style for this node, if any.

fn get_item_style_func(&self) -> Option<&StyleFunc>

Returns the item style function for this node, if any.

fn get_enumerator_style_func(&self) -> Option<&StyleFunc>

Returns the enumerator style function for this node, if any.