Struct Cli 

pub struct Cli {

    pub base: PathBuf,
    pub name: Option<String>,
    pub mode: Option<Mode>,
    pub ext: Vec<String>,
    pub hidden: bool,
    pub follow: bool,
    pub no_ignore: bool,
    pub min_lines: Option<u64>,
    pub max_lines: Option<u64>,
    pub min_words: Option<u64>,
    pub max_words: Option<u64>,
    pub min_chars: Option<u64>,
    pub max_chars: Option<u64>,
    pub min_files_per_folder: Option<usize>,
    pub max_files_per_folder: Option<usize>,
    pub sort: SortKey,
    pub desc: bool,
    pub tree: bool,
    pub flat: bool,
    pub summary: bool,
    pub group: GroupBy,
    pub json: bool,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub explain: Option<Format>,
}

Fields

base: PathBuf

Root to walk (relative or absolute), independent of the current directory.

name: Option<String>

File-name pattern; ‘|’-separated alternatives, each substring->glob->regex promoted and anchored.

mode: Option<Mode>

Pin how –name/–ext patterns are interpreted (promotion off): literal, glob, or regex.

ext: Vec<String>

Restrict to these extensions (comma-separated, no dots), e.g. –ext rs,toml. Combined with –name as alternatives.

hidden: bool

Include dot-entries (names starting with ‘.’); default skips them.

follow: bool

Follow symlinks while traversing.

no_ignore: bool

Walk gitignored / .ignore files too (the .git directory is always skipped); by default the walk skips what git would.

min_lines: Option<u64>

Only include files with at least N lines.

max_lines: Option<u64>

Only include files with at most N lines.

min_words: Option<u64>

Only include files with at least N words.

max_words: Option<u64>

Only include files with at most N words.

min_chars: Option<u64>

Only include files with at least N characters.

max_chars: Option<u64>

Only include files with at most N characters.

min_files_per_folder: Option<usize>

Only include folders that directly contain at least N matching files.

max_files_per_folder: Option<usize>

Only include folders that directly contain at most N matching files.

sort: SortKey

Sort key: path, name, lines, words, chars, or ext.

desc: bool

Sort descending instead of ascending.

tree: bool

Output mode: an indented file tree with per-file and per-folder counts (default).

flat: bool

Output mode: one matching file per line with its counts.

summary: bool

Output mode: aggregate counts only, grouped by –group.

group: GroupBy

Grouping for –summary: ext, dir, or none (grand total only).

json: bool

Emit a structured JSON result instead of text.

timeout: Option<f64>

Abort with exit 2 if the report exceeds SECS seconds (fractional allowed).

heartbeat: HeartbeatOpts

explain: Option<Format>

Print agent usage docs (md or json) and exit.

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

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 Cli

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) -> Self

where 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.