Struct FinderBuilder

pub struct FinderBuilder<S>
where
    S: BytesStorage,
{ /* private fields */ }

A builder for creating a Finder instance with customisable options.

This builder allows you to set various options such as hiding hidden files, case sensitivity, keeping directories in results, matching file extensions, setting maximum search depth, following symlinks, and applying a custom filter function.

Implementations

impl<S> FinderBuilder<S>

where S: BytesStorage + 'static + Clone + Send,

pub fn new(root: impl AsRef<OsStr>, pattern: impl AsRef<str>) -> Self

Create a new FinderBuilder with required fields

pub const fn keep_hidden(self, hide_hidden: bool) -> Self

Set whether to hide hidden files, defaults to true

pub const fn case_insensitive(self, case_insensitive: bool) -> Self

Set case insensitive matching,defaults to true

pub const fn keep_dirs(self, keep_dirs: bool) -> Self

Set whether to keep directories in results,defaults to false

pub const fn file_name_only(self, short_path: bool) -> Self

Set whether to use short pathss in regex matching, defaults to true

pub fn extension_match<C: AsRef<str>>(self, extension_match: Option<C>) -> Self

Set extension to match

pub const fn max_depth(self, max_depth: Option<u8>) -> Self

Set maximum search depth

pub const fn follow_symlinks(self, follow_symlinks: bool) -> Self

Set whether to follow symlinks, defaults to false. Careful for recursion!

pub const fn filter(self, filter: Option<DirEntryFilter<S>>) -> Self

Set a custom filter

pub fn build(self) -> Finder<S>

Build the Finder instance