Struct broot::tree_build::TreeBuilder
source · [−]pub struct TreeBuilder<'c> {
pub options: TreeOptions,
pub matches_max: Option<usize>,
/* private fields */
}
Expand description
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 arena and kept until the end. Most operations and temporary data structures just deal with the ids of lines the blines arena.
Fields
options: TreeOptions
matches_max: Option<usize>
Implementations
sourceimpl<'c> TreeBuilder<'c>
impl<'c> TreeBuilder<'c>
pub fn from(
path: PathBuf,
options: TreeOptions,
targeted_size: usize,
con: &'c AppContext
) -> Result<TreeBuilder<'c>, TreeBuildError>
sourcepub fn build_tree(
self,
total_search: bool,
dam: &Dam
) -> Result<Tree, TreeBuildError>
pub fn build_tree(
self,
total_search: bool,
dam: &Dam
) -> Result<Tree, TreeBuildError>
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)
sourcepub fn build_paths<F>(
self,
total_search: bool,
dam: &Dam,
filter: F
) -> Result<Vec<PathBuf>, TreeBuildError>where
F: Fn(&BLine) -> bool,
pub fn build_paths<F>(
self,
total_search: bool,
dam: &Dam,
filter: F
) -> Result<Vec<PathBuf>, TreeBuildError>where
F: Fn(&BLine) -> bool,
Auto Trait Implementations
impl<'c> !RefUnwindSafe for TreeBuilder<'c>
impl<'c> Send for TreeBuilder<'c>
impl<'c> Sync for TreeBuilder<'c>
impl<'c> Unpin for TreeBuilder<'c>
impl<'c> !UnwindSafe for TreeBuilder<'c>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more