Struct Cli 

pub struct Cli {
    pub question: Option<String>,
    pub every: f64,
    pub timeout: f64,
    pub ok_match: Option<String>,
    pub err_match: Option<String>,
    pub mode: Option<Mode>,
    pub heartbeat: HeartbeatOpts,
    pub emit: Option<String>,
    pub emit_stderr: Option<String>,
    pub quiet: bool,
    pub explain: Option<Format>,
    pub probe: Vec<String>,
}

Fields

question: Option<String>

Question this wait answers; printed as a “== … ==” banner.

every: f64

Seconds between probe runs (fractional allowed).

timeout: f64

Hard bound on the whole wait (fractional allowed). Required: a wait is bounded by design.

ok_match: Option<String>

SUCCESS when this pattern (substring->glob->regex promoted) appears in the probe’s output. When supplied it is the REQUIRED proof: a clean exit without it means “not yet”.

err_match: Option<String>

End the wait immediately with ERROR when this pattern appears in the probe’s output (decisive over –ok-match, exactly as in ct-test).

mode: Option<Mode>

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

heartbeat: HeartbeatOpts

emit: Option<String>

Template written to stdout when the wait ends. Tokens: {RESULT} {ELAPSED} {TICKS} {REASON} {QUESTION} {CMD}.

emit_stderr: Option<String>

Template written to stderr when the wait ends (same tokens as –emit).

quiet: bool

Suppress the banner and the default outcome line.

explain: Option<Format>

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

probe: Vec<String>

The probe (after --): an argv run directly each tick, never through a shell. Exit 0 ends the wait with SUCCESS; any other exit means “not yet”.

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.