Struct Cli 

pub struct Cli {

    pub base: PathBuf,
    pub name: Option<String>,
    pub ext: Vec<String>,
    pub hidden: bool,
    pub follow: bool,
    pub pattern: Option<String>,
    pub mode: Option<Mode>,
    pub kind: Vec<String>,
    pub depth: Option<usize>,
    pub flat: bool,
    pub question: Option<String>,
    pub expect: Option<String>,
    pub emit: Option<String>,
    pub emit_stderr: Option<String>,
    pub quiet: bool,
    pub json: bool,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub explain: Option<Format>,
}

Fields

base: PathBuf

Root to outline; a file outlines just that file, a directory is descended.

name: Option<String>

Limit to files whose name matches; ‘|’-separated alternatives, each substring->glob->regex promoted and anchored.

ext: Vec<String>

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

hidden: bool

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

follow: bool

Follow symlinks while traversing.

pattern: Option<String>

Keep entries whose name matches (substring->glob->regex promoted, anchored to the whole declaration name).

mode: Option<Mode>

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

kind: Vec<String>

Keep entries of these kinds (comma-separated), e.g. –kind fn,struct. Kinds are per-language keywords.

depth: Option<usize>

Keep entries nested at most N levels deep (1 = top-level only).

flat: bool

Output one grep-friendly row per matched entry: path:start:end:kind:name.

question: Option<String>

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

expect: Option<String>

Verdict expectation over the matched-entry count: any|none|N|=N|+N|-N (default: any).

emit: Option<String>

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

emit_stderr: Option<String>

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

quiet: bool

Print nothing; report via exit status (and –emit, which still fires).

json: bool

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

timeout: Option<f64>

Abort with exit 2 if the run 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.