Struct AppOptions 

pub struct AppOptions {

    pub pane_dirs: Vec<PathBuf>,
    pub extensions: Vec<String>,
    pub show_hidden: bool,
    pub show_sizes: bool,
    pub show_dir_sizes: bool,
    pub use_trash: bool,
    pub show_git: bool,
    pub bookmarks: Vec<PathBuf>,
    pub async_loading: bool,
    pub theme_idx: usize,
    pub show_theme_panel: bool,
    pub single_pane: bool,
    pub sort_mode: SortMode,
    pub cd_on_exit: bool,
    pub editor: Editor,
    pub verbose: bool,
    pub startup_log: Vec<String>,
}

Startup configuration passed to App::new.

Grouping all constructor parameters into a single struct keeps the call sites readable and avoids the clippy::too_many_arguments limit.

Example

use tui_file_explorer::{App, AppOptions};

let dir = std::env::temp_dir();
let app = App::new(AppOptions {
    pane_dirs: vec![dir.clone(), dir],
    ..AppOptions::default()
});

Fields

pane_dirs: Vec<PathBuf>

Starting directories, one per pane (at least one is required).

extensions: Vec<String>

File-extension filter (empty = show all).

show_hidden: bool

Show hidden (dot-prefixed) entries on startup.

show_sizes: bool

Show file/folder sizes on startup. Defaults to true; set to false for the snappiest possible browsing of huge directory trees.

show_dir_sizes: bool

Compute recursive folder sizes on startup. When false folders show a shallow item count instead. Defaults to true.

use_trash: bool

Send deletions to the OS trash instead of unlinking them. Needs the trash feature; ignored (permanent delete) without it. Defaults to false for library users — the tfe binary turns it on.

show_git: bool

Show git change markers (M, A, ?, …) next to entries.

bookmarks: Vec<PathBuf>

Saved bookmark folders.

async_loading: bool

Read directories on a background thread so a slow disk never freezes the UI (see FileExplorer::async_loading). Off by default; tfe enables it.

theme_idx: usize

Index into the theme catalogue to use on startup.

show_theme_panel: bool

Whether the theme-picker side-panel should be open on startup.

single_pane: bool

Whether to start in single-pane mode.

sort_mode: SortMode

Active sort mode.

cd_on_exit: bool

Whether cd-on-exit is enabled.

editor: Editor

Which editor to open when the user presses e on a file.

verbose: bool

When true, show a debug log panel in the TUI and write logs to a file. Activated by --verbose / -v.

startup_log: Vec<String>

Pre-App log lines collected during startup (before the App existed). These are drained into App::debug_log on construction.

Trait Implementations

impl Clone for AppOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AppOptions

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

Formats the value using the given formatter.

impl Default for AppOptions

fn default() -> Self

Returns the “default value” for a type.