Struct broot::app::AppContext

pub struct AppContext {

    pub initial_root: PathBuf,
    pub initial_tree_options: TreeOptions,
    pub config_paths: Vec<PathBuf>,
    pub launch_args: Args,
    pub verb_store: VerbStore,
    pub special_paths: Vec<SpecialPath>,
    pub search_modes: SearchModeMap,
    pub show_selection_mark: bool,
    pub ext_colors: ExtColorMap,
    pub syntax_theme: Option<SyntaxTheme>,
    pub standard_status: StandardStatus,
    pub true_colors: bool,
    pub icons: Option<Box<dyn IconPlugin + Send + Sync>>,
    pub modal: bool,
    pub capture_mouse: bool,
    pub max_panels_count: usize,
    pub quit_on_last_cancel: bool,
    pub file_sum_threads_count: usize,
    pub max_staged_count: usize,
    pub content_search_max_file_size: usize,
}

The container that can be passed around to provide the configuration things for the whole life of the App

Fields

initial_root: PathBuf

The initial tree root

initial_tree_options: TreeOptions

Initial tree options

config_paths: Vec<PathBuf>

where’s the config file we’re using This vec can’t be empty

launch_args: Args

all the arguments specified at launch

verb_store: VerbStore

the verbs in use (builtins and configured ones)

special_paths: Vec<SpecialPath>

the paths for which there’s a special behavior to follow (comes from conf)

search_modes: SearchModeMap

the map between search prefixes and the search mode to apply

show_selection_mark: bool

whether to show a triangle left to selected lines

ext_colors: ExtColorMap

mapping from file extension to colors (comes from conf)

syntax_theme: Option<SyntaxTheme>

the syntect theme to use for text files previewing

standard_status: StandardStatus

precomputed status to display in standard cases (ie when no verb is involved)

true_colors: bool

whether we can use 24 bits colors for previewed images

icons: Option<Box<dyn IconPlugin + Send + Sync>>

map extensions to icons, icon set chosen based on config Send, Sync safely because once created, everything is immutable

modal: bool

modal (aka “vim) mode enabled

capture_mouse: bool

Whether to support mouse interactions

max_panels_count: usize

max number of panels (including preview) that can be open. Guaranteed to be at least 2.

quit_on_last_cancel: bool

whether to quit broot when the user hits “escape” and there’s nothing to cancel

file_sum_threads_count: usize

number of threads used by file_sum (count, size, date) computation

max_staged_count: usize

number of files which may be staged in one staging operation

content_search_max_file_size: usize

max file size when searching file content

Implementations

impl AppContext

pub fn from(
launch_args: Args,
verb_store: VerbStore,
config: &Conf
) -> Result<Self, ProgramError>