Struct Cli 

pub struct Cli {

    pub base: PathBuf,
    pub name: Option<String>,
    pub type: Vec<EntryType>,
    pub grep: Option<String>,
    pub mode: Option<Mode>,
    pub size: Option<String>,
    pub hidden: bool,
    pub follow: bool,
    pub no_ignore: bool,
    pub limit: Option<usize>,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub question: Option<String>,
    pub expect: Option<String>,
    pub emit: Option<String>,
    pub emit_stderr: Option<String>,
    pub list: bool,
    pub summary: bool,
    pub detail: bool,
    pub quiet: bool,
    pub json: bool,
    pub explain: Option<Format>,
}

Fields

base: PathBuf

Search root (relative or absolute), independent of the current directory.

name: Option<String>

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

type: Vec<EntryType>

Restrict to entry kinds: f=file, d=dir, l=symlink (repeatable or comma-joined).

grep: Option<String>

Content pattern (substring->glob->regex promoted); searches file contents. Accepts file:PATH / text:VALUE; a multi-line pattern matches as a line-anchored literal block.

mode: Option<Mode>

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

size: Option<String>

Size predicate [+|-]N[k|m|g]: +N larger than, -N smaller than, N at least N.

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.

limit: Option<usize>

Stop after N matches.

timeout: Option<f64>

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

heartbeat: HeartbeatOpts

question: Option<String>

Question this search answers, framing it as a test; printed as a “== … ==” banner unless –quiet.

expect: Option<String>

Verdict expectation over the match count: any|none|N|=N|+N|-N (default: any). Turns the search into a pass/fail test whose exit status follows the verdict.

emit: Option<String>

Template written to stdout after the search. Tokens: {RESULT} {QUESTION} {COUNT} {LINES} {BASE} {MATCHES}.

emit_stderr: Option<String>

Template written to stderr after the search (same tokens as –emit).

list: bool

Output mode: print one matching path per line (default).

summary: bool

Output mode: print counts only.

detail: bool

Output mode: print matches plus, for –grep, each hit as path:line:text.

quiet: bool

Output mode: print nothing; report via exit status only.

json: bool

Emit a structured JSON result instead of text (overrides the output mode and –emit).

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.