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 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 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 build(self) -> FileExplorer

Consume the builder and return a fully initialised FileExplorer.