Struct TuiConfig 

#[non_exhaustive]
pub struct TuiConfig {
    pub plugin_worker_executable: Option<PathBuf>,
    pub scan_on_startup: Option<bool>,
    pub cwd_file: Option<PathBuf>,
    pub print_cwd: bool,
    pub replace_policy: ReplacePolicy,
    pub delete_mode: DeleteMode,
    pub units: Units,
    pub apparent_size: bool,
    pub snapshot: Option<Box<Snapshot>>,
}

Configuration for the TUI application.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

plugin_worker_executable: Option<PathBuf>

Host executable supporting the private plugin worker protocol. If absent, embedded TUI hosts do not load plugins into their own process implicitly.

scan_on_startup: Option<bool>

Whether to automatically start scanning on startup. None means defer to the user’s saved settings. Some(true) forces scanning on, Some(false) forces it off.

cwd_file: Option<PathBuf>

Path to a file where the last working directory will be written on exit. This enables shell integration for cd on exit functionality.

print_cwd: bool

Whether to print the last working directory to stdout on exit.

replace_policy: ReplacePolicy

What happens to an item the user chooses to overwrite on paste.

delete_mode: DeleteMode

What happens to items the user deletes.

units: Units

How sizes are displayed.

apparent_size: bool

Show file lengths instead of disk usage.

snapshot: Option<Box<Snapshot>>

A saved scan to browse instead of the filesystem.

Implementations

impl TuiConfig

pub fn with_plugin_worker_executable(self, path: PathBuf) -> Self

Enable supervised plugins using a worker-capable host executable.

pub fn new() -> Self

Create a new config with default values.

pub fn with_snapshot(self, source: PathBuf, tree: FileTree) -> Self

Browse tree, read from source, instead of the filesystem.

pub fn with_apparent_size(self, apparent: bool) -> Self

Show file lengths instead of disk usage.

pub fn with_scan_on_startup(self, scan: bool) -> Self

Enable auto-scan on startup.

pub fn with_cwd_file(self, path: Option<PathBuf>) -> Self

Set the cwd file path for shell integration.

pub fn with_print_cwd(self, print: bool) -> Self

Enable printing cwd on exit.

pub fn with_units(self, units: Units) -> Self

Display sizes in units.

Trait Implementations

impl Clone for TuiConfig

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 TuiConfig

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

Formats the value using the given formatter.

impl Default for TuiConfig

fn default() -> Self

Returns the “default value” for a type.