Struct FileExplorerBuilder 

pub struct FileExplorerBuilder { /* private fields */ }

Builder for FileExplorer.

Obtain one via FileExplorer::builder.

Example

use tui_file_explorer::{FileExplorer, SortMode};

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .allow_extension("iso")
    .allow_extension("img")
    .show_hidden(false)
    .sort_mode(SortMode::SizeDesc)
    .build();

Implementations

impl FileExplorerBuilder

pub fn new(initial_dir: PathBuf) -> Self

Create a builder rooted at initial_dir.

pub fn filesystem(self, filesystem: SharedFileSystem) -> Self

Use a custom filesystem backend.

pub fn extension_filter(self, filter: Vec<String>) -> Self

Set the full extension filter list at once.

Replaces any extensions added with allow_extension.

use tui_file_explorer::FileExplorer;

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .extension_filter(vec!["iso".into(), "img".into()])
    .build();

pub fn allow_extension(self, ext: impl Into<String>) -> Self

Append a single allowed extension.

Call multiple times to build up the filter:

use tui_file_explorer::FileExplorer;

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .allow_extension("iso")
    .allow_extension("img")
    .build();

pub fn show_hidden(self, show: bool) -> Self

Set whether hidden (dot-file) entries are shown on startup.

use tui_file_explorer::FileExplorer;

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .show_hidden(true)
    .build();

pub fn show_sizes(self, show: bool) -> Self

Set whether file/folder sizes are shown on startup.

Defaults to true. Set to false for the snappiest possible browsing of huge directory trees, since it skips the recursive directory-size walk entirely.

use tui_file_explorer::FileExplorer;

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .show_sizes(false)
    .build();

pub fn show_dir_sizes(self, show: bool) -> Self

Set whether directories show their recursive byte size on startup.

Defaults to true. With false, files still show their size but directories show a shallow item count and the (potentially slow) recursive walk is skipped. Has no effect when show_sizes is false.

use tui_file_explorer::FileExplorer;

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .show_dir_sizes(false)
    .build();

pub fn async_loading(self, enabled: bool) -> Self

Read directories on a background thread (see FileExplorer::async_loading). Off by default.

pub fn show_git(self, show: bool) -> Self

Show a git change marker (M, A, ?, …) next to changed entries.

Off by default; runs git status on a background thread.

pub fn keymap(self, keymap: Keymap) -> Self

Replace the key bindings (defaults to Keymap::default).

pub fn sort_mode(self, mode: SortMode) -> Self

Set the initial sort mode.

use tui_file_explorer::{FileExplorer, SortMode};

let explorer = FileExplorer::builder(std::env::current_dir().unwrap())
    .sort_mode(SortMode::SizeDesc)
    .build();

pub fn selection_mode(self, mode: SelectionMode) -> Self

Configure which entry kinds can be confirmed as selections.

pub fn page_size(self, size: usize) -> Self

Set the number of entries scrolled by Page Up / Page Down.

Defaults to 10.

pub fn build(self) -> FileExplorer

Consume the builder and return a fully initialised FileExplorer.

Filesystem errors are retained as explorer status for backwards compatibility. Use Self::try_build when the host needs typed errors.

pub fn try_build(self) -> Result<FileExplorer, ExplorerError>

Build an explorer and return an error when its initial directory cannot be read.

Trait Implementations

impl Debug for FileExplorerBuilder

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

Formats the value using the given formatter.