Struct Filter

pub struct Filter { /* private fields */ }

A filtered view of children that applies a predicate function.

Filter wraps a children collection and applies a filtering function to determine which children should be visible. Only children that pass the filter predicate are accessible through the Children interface.

Examples

use lipgloss_tree::{Filter, new_string_data, Children};

let data = new_string_data(&["A", "B", "C", "D"]);
let filtered = Filter::new(Box::new(data))
    .filter(|i| i % 2 == 0); // Only even indices

assert_eq!(filtered.length(), 2); // Only "A" and "C" are visible

Implementations

impl Filter

pub fn new(data: Box<dyn Children>) -> Self

Creates a new filter with no filtering applied.

Initially, all children from the underlying data will be visible. Use the filter() method to apply filtering logic.

Arguments

• data - The children collection to wrap and filter

Examples

use lipgloss_tree::{Filter, new_string_data, Children};

let data = new_string_data(&["Item 1", "Item 2"]);
let filter = Filter::new(Box::new(data));
assert_eq!(filter.length(), 2); // No filtering applied yet

pub fn filter<F>(self, f: F) -> Self

where F: Fn(usize) -> bool + 'static,

Sets the filtering predicate function.

The function receives the index of each child in the underlying collection and should return true for children that should be visible, false for children that should be hidden.

Arguments

• f - A predicate function that takes an index and returns a boolean

Examples

use lipgloss_tree::{Filter, new_string_data, Children, Node};

let data = new_string_data(&["A", "B", "C", "D", "E"]);
let filtered = Filter::new(Box::new(data))
    .filter(|i| i >= 2); // Only show items at index 2 and higher

assert_eq!(filtered.length(), 3); // "C", "D", "E"
assert_eq!(filtered.at(0).unwrap().value(), "C");

Trait Implementations

impl Children for Filter

fn at(&self, index: usize) -> Option<&dyn Node>

Returns the node at the given index.

fn length(&self) -> usize

Returns the total number of children in this collection.