Skip to main content

AppOptions

Struct AppOptions 

Source
pub struct AppOptions {
    pub left_dir: PathBuf,
    pub right_dir: PathBuf,
    pub extensions: Vec<String>,
    pub show_hidden: 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>,
}
Expand description

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

let app = App::new(AppOptions {
    left_dir: PathBuf::from("/home/user"),
    right_dir: PathBuf::from("/tmp"),
    ..AppOptions::default()
});

Fields§

§left_dir: PathBuf

Starting directory for the left pane.

§right_dir: PathBuf

Starting directory for the right pane.

§extensions: Vec<String>

File-extension filter (empty = show all).

§show_hidden: bool

Show hidden (dot-prefixed) entries on startup.

§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§

Source§

impl Clone for AppOptions

Source§

fn clone(&self) -> AppOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AppOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AppOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.