Struct broot::cli::Args

pub struct Args {

    pub dates: bool,
    pub no_dates: bool,
    pub only_folders: bool,
    pub no_only_folders: bool,
    pub show_root_fs: bool,
    pub show_git_info: bool,
    pub no_show_git_info: bool,
    pub git_status: bool,
    pub hidden: bool,
    pub no_hidden: bool,
    pub git_ignored: bool,
    pub no_git_ignored: bool,
    pub permissions: bool,
    pub no_permissions: bool,
    pub sizes: bool,
    pub no_sizes: bool,
    pub sort_by_count: bool,
    pub sort_by_date: bool,
    pub sort_by_size: bool,
    pub sort_by_type: bool,
    pub sort_by_type_dirs_first: bool,
    pub sort_by_type_dirs_last: bool,
    pub whale_spotting: bool,
    pub no_sort: bool,
    pub trim_root: bool,
    pub no_trim_root: bool,
    pub outcmd: Option<PathBuf>,
    pub cmd: Option<String>,
    pub color: TriBool,
    pub conf: Option<String>,
    pub height: Option<u16>,
    pub install: bool,
    pub set_install_state: Option<ShellInstallState>,
    pub print_shell_function: Option<String>,
    pub listen: Option<String>,
    pub get_root: bool,
    pub write_default_conf: Option<PathBuf>,
    pub send: Option<String>,
    pub root: Option<PathBuf>,
}

A tree explorer and a customizable launcher

Complete documentation lives at https://dystroy.org/broot“

Fields

dates: bool

Show the last modified date of files and directories“

no_dates: bool

Don’t show the last modified date“

only_folders: bool

Only show folders

no_only_folders: bool

Show folders and files alike

show_root_fs: bool

Show filesystem info on top

show_git_info: bool

Show git statuses on files and stats on repo

no_show_git_info: bool

Don’t show git statuses on files and stats on repo

git_status: bool

Only show files having an interesting git status, including hidden ones

hidden: bool

Show hidden files

no_hidden: bool

Don’t show hidden files

git_ignored: bool

Show git ignored files

no_git_ignored: bool

Don’t show git ignored files

permissions: bool

Show permissions

no_permissions: bool

Don’t show permissions

sizes: bool

Show the size of files and directories

no_sizes: bool

Don’t show sizes

sort_by_count: bool

Sort by count (only show one level of the tree)

sort_by_date: bool

Sort by date (only show one level of the tree)

sort_by_size: bool

Sort by size (only show one level of the tree)

sort_by_type: bool

Same as sort-by-type-dirs-first

sort_by_type_dirs_first: bool

Sort by type, directories first (only show one level of the tree)

sort_by_type_dirs_last: bool

Sort by type, directories last (only show one level of the tree)

whale_spotting: bool

Sort by size, show ignored and hidden files

no_sort: bool

Don’t sort

trim_root: bool

Trim the root too and don’t show a scrollbar

no_trim_root: bool

Don’t trim the root level, show a scrollbar

outcmd: Option<PathBuf>

Where to write the produced cmd (if any)

cmd: Option<String>

Semicolon separated commands to execute

color: TriBool

Whether to have styles and colors (auto is default and usually OK)

conf: Option<String>

Semicolon separated paths to specific config files“),

height: Option<u16>

Height (if you don’t want to fill the screen or for file export)

install: bool

Install or reinstall the br shell function

set_install_state: Option<ShellInstallState>

Where to write the produced cmd (if any)

print_shell_function: Option<String>

Print to stdout the br function for a given shell

listen: Option<String>

A socket to listen to for commands

get_root: bool

Ask for the current root of the remote broot

write_default_conf: Option<PathBuf>

Write default conf files in given directory

send: Option<String>

A socket that broot sends commands to before quitting

root: Option<PathBuf>

Root Directory

Trait Implementations

impl Args for Args

fn augment_args<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

impl CommandFactory for Args

fn into_app<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.