Struct Cli 

pub struct Cli {

    pub path: PathBuf,
    pub range: Option<String>,
    pub pattern: Option<String>,
    pub mode: Option<Mode>,
    pub context: usize,
    pub limit: Option<usize>,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub plain: bool,
    pub frontmatter: bool,
    pub no_frontmatter: bool,
    pub json: bool,
    pub json_pretty: bool,
    pub explain: Option<Format>,
}

Fields

path: PathBuf

File to view.

range: Option<String>

Line range A:B (1-based, inclusive); also A: (to end), :B (from start), or A (one line).

pattern: Option<String>

Show only lines matching this pattern (substring->glob->regex promoted), with –context around each. Accepts file:PATH / text:VALUE; a multi-line pattern matches as a line-anchored literal block.

mode: Option<Mode>

Pin how the pattern is interpreted (promotion off): literal, glob, or regex.

context: usize

Lines of context shown around each –match hit.

limit: Option<usize>

Cap the number of lines emitted.

timeout: Option<f64>

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

heartbeat: HeartbeatOpts

plain: bool

Suppress the line-number gutter in text output.

frontmatter: bool

OKF: show only the concept’s frontmatter block.

no_frontmatter: bool

OKF: omit the concept’s frontmatter block from the shown lines.

json: bool

Emit a structured JSON result instead of text.

json_pretty: bool

Like --json, but pretty-printed (indented).

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.