Struct broot::tree_build::TreeBuilder

pub struct TreeBuilder { /* fields omitted */ }

The TreeBuilder builds a Tree according to options (including an optional search pattern) Instead of the final TreeLine, the builder uses an internal structure: BLine. All BLines used during build are stored in the blines vector and kept until the end. Most operations and temporary data structures just deal with the indexes of lines in the blines vector.

Methods

impl TreeBuilder

pub fn from(
    path: PathBuf,
    options: TreeOptions,
    targeted_size: usize
) -> Result<TreeBuilder, TreeBuildError>

pub fn build(
    self,
    task_lifetime: &TaskLifetime,
    total_search: bool
) -> Option<Tree>

build a tree. Can be called only once per builder.

Return None if the lifetime expires before end of computation (usually because the user hit a key)