Struct Cli 

pub struct Cli {

    pub base: PathBuf,
    pub name: Option<String>,
    pub mode: Option<Mode>,
    pub hidden: bool,
    pub follow: bool,
    pub no_ignore: bool,
    pub set: Vec<String>,
    pub delete: Vec<String>,
    pub add: Vec<String>,
    pub move_first: Vec<String>,
    pub move_last: Vec<String>,
    pub move_up: Vec<String>,
    pub move_down: Vec<String>,
    pub format: Option<DocFormat>,
    pub expect: Option<String>,
    pub dry_run: bool,
    pub quiet: bool,
    pub json: bool,
    pub timeout: Option<f64>,
    pub heartbeat: HeartbeatOpts,
    pub explain: Option<Format>,
}

Fields

base: PathBuf

Root to patch; a file patches 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.

mode: Option<Mode>

Pin how –name is interpreted (promotion off): literal, glob, or regex.

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.

set: Vec<String>

Set PATH to VALUE (repeatable). VALUE is parsed as JSON, or taken as a string if it is not valid JSON. file:PATH reads the value verbatim as a string; text:VALUE escapes the prefix.

delete: Vec<String>

Delete the node at PATH (repeatable).

add: Vec<String>

Append VALUE to the array at PATH, no index needed (repeatable). VALUE is parsed as JSON or taken as a string; file:PATH reads it verbatim as a string.

move_first: Vec<String>

Move the array element selected by PATH to the front of its list (repeatable).

move_last: Vec<String>

Move the array element selected by PATH to the end of its list (repeatable).

move_up: Vec<String>

Move the array element selected by PATH one position earlier (repeatable).

move_down: Vec<String>

Move the array element selected by PATH one position later (repeatable).

format: Option<DocFormat>

Force the document format instead of detecting it from the file extension.

expect: Option<String>

Verdict expectation over the total number of changes: any|none|N|=N|+N|-N (default: any).

dry_run: bool

Show what would change and the verdict, but write nothing.

quiet: bool

Suppress the per-file lines; print only the summary.

json: bool

Emit a structured JSON result instead of text.

timeout: Option<f64>

Abort with exit 2 if the scan exceeds SECS seconds (fractional allowed). Never interrupts the write phase: once a SUCCESS verdict starts writing, every write completes.

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.