Struct broot::conf::Conf

pub struct Conf {

    pub files: Vec<PathBuf>,
    pub default_flags: Option<String>,
    pub date_time_format: Option<String>,
    pub verbs: Vec<VerbConf>,
    pub skin: Option<AHashMap<String, SkinEntry>>,
    pub special_paths: AHashMap<Glob, SpecialHandling>,
    pub search_modes: Option<FnvHashMap<String, String>>,
    pub disable_mouse_capture: Option<bool>,
    pub capture_mouse: Option<bool>,
    pub cols_order: Option<ColsConf>,
    pub show_selection_mark: Option<bool>,
    pub ext_colors: AHashMap<String, String>,
    pub syntax_theme: Option<SyntaxTheme>,
    pub true_colors: Option<bool>,
    pub icon_theme: Option<String>,
    pub modal: Option<bool>,
    pub max_panels_count: Option<usize>,
    pub quit_on_last_cancel: Option<bool>,
    pub file_sum_threads_count: Option<usize>,
    pub max_staged_count: Option<usize>,
    pub imports: Vec<Import>,
    pub show_matching_characters_on_path_searches: Option<bool>,
}

The configuration read from conf.toml or conf.hjson file(s)

Fields

files: Vec<PathBuf>

the files used to load this configuration

default_flags: Option<String>

date_time_format: Option<String>

verbs: Vec<VerbConf>

skin: Option<AHashMap<String, SkinEntry>>

special_paths: AHashMap<Glob, SpecialHandling>

search_modes: Option<FnvHashMap<String, String>>

disable_mouse_capture: Option<bool>

Obsolete, kept for compatibility: you should now use capture_mouse

capture_mouse: Option<bool>

cols_order: Option<ColsConf>

show_selection_mark: Option<bool>

ext_colors: AHashMap<String, String>

syntax_theme: Option<SyntaxTheme>

true_colors: Option<bool>

icon_theme: Option<String>

modal: Option<bool>

max_panels_count: Option<usize>

quit_on_last_cancel: Option<bool>

file_sum_threads_count: Option<usize>

max_staged_count: Option<usize>

imports: Vec<Import>

show_matching_characters_on_path_searches: Option<bool>

Implementations

impl Conf

pub fn default_location() -> PathBuf

return the path to the default conf.toml file. If there’s no conf.hjson file in the default conf directory, and if there’s a toml file, return this toml file.

pub fn from_default_location() -> Result<Conf, ProgramError>

read the configuration file from the default OS specific location. Create it if it doesn’t exist

pub fn solve_conf_path(&self, path: &str) -> Option<PathBuf>

pub fn read_file(&mut self, path: PathBuf) -> Result<(), ProgramError>

read the configuration from a given path. Assume it exists. Values set in the read file replace the ones of self. Errors are printed on stderr (assuming this function is called before terminal alternation).

Trait Implementations

impl Clone for Conf

fn clone(&self) -> Conf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Conf

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

Formats the value using the given formatter.

impl Default for Conf

fn default() -> Conf

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Conf

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.