Struct GetCommand 

pub struct GetCommand {
    pub output_format: OutputFormat,
    pub strip_newline: bool,
    pub file_path: Option<PathBuf>,
    pub pattern: Option<String>,
    pub separator: Option<String>,
}

Fields

output_format: OutputFormat

The format specifying how the output is printed.

All newlines are in the output are LF.

Format-specific remarks:

— value:

If the value is a string, all surrounding quotes will be stripped and all escape sequences will be unescaped.

If the value is an integer or float, it will be output in a decimal format without any rounding.

If the value is an array, all of its items will be output on separate lines.

If the value is a table or an array that contains tables, the operation will fail.

— toml:

Comments and formatting will not be preserved. It is possible to select arrays and individual values that are not tables, in this case the output will not be a valid TOML document.

strip_newline: bool

Strip the trailing newline from the output.

If this is not provided, all output will end with a line-feed character.

file_path: Option<PathBuf>

Path to the TOML document, if omitted the standard input will be used.

pattern: Option<String>

A dotted key pattern to the value within the TOML document.

If omitted, the entire document will be printed.

If the pattern yielded no values, the operation will fail.

The pattern supports jq-like syntax and glob patterns as well:

Examples:

• table.array[1].foo
• table.array.1.foo
• table.array[*].foo
• table.array.*.foo
• dependencies.tokio-*.version

separator: Option<String>

A string that separates array values when printing to stdout.

If --separator is specified with a non text output format, the operation will fail.

Trait Implementations

impl Args for GetCommand

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 Clone for GetCommand

fn clone(&self) -> GetCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl FromArgMatches for GetCommand

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.