pub struct GetCommand {
    pub output_format: OutputFormat,
    pub strip_newline: bool,
    pub file_path: Option<PathBuf>,
    pub pattern: 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

Trait Implementations

Append to Command so it can instantiate Self. Read more

Append to Command so it can update self. Read more

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more

Assign values from ArgMatches to self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Converts self into T using Into<T>. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Pipes by value. This is generally the method you want to use. Read more

Borrows self and passes that borrow into the pipe function. Read more

Mutably borrows self and passes that borrow into the pipe function. Read more

Borrows self, then passes self.borrow() into the pipe function. Read more

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Borrows self, then passes self.as_ref() into the pipe function.

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

Borrows self, then passes self.deref() into the pipe function.

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

Immutable access to a value. Read more

Mutable access to a value. Read more

Immutable access to the Borrow<B> of a value. Read more

Mutable access to the BorrowMut<B> of a value. Read more

Immutable access to the AsRef<R> view of a value. Read more

Mutable access to the AsMut<R> view of a value. Read more

Immutable access to the Deref::Target of a value. Read more

Mutable access to the Deref::Target of a value. Read more

Calls .tap() only in debug builds, and is erased in release builds.

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

Attempts to convert self into T using TryInto<T>. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more