Struct cli_xtask::subcommand::Fmt

#[non_exhaustive]
pub struct Fmt {
    pub env_args: EnvArgs,
    pub package_args: PackageArgs,
    pub extra_options: Vec<String>,
}

Available on crate feature subcommand-fmt only.

Arguments definition of the fmt subcommand.

cargo-xtask-fmt(1)

`cargo fmt` with options useful for testing and continuous integration

Usage: cargo xtask fmt [OPTIONS] [EXTRA_OPTIONS]...

Arguments:
  [EXTRA_OPTIONS]...  Options to pass to the `cargo fmt`

Options:
  -e, --env <KEY>=<VALUE>          Environment variables to set for the subcommand
  -v, --verbose...                 More output per occurrence
      --exhaustive                 Same as `--all-workspaces --workspace --each-feature`
  -q, --quiet...                   Less output per occurrence
      --all-workspaces             Run the subcommand on all workspaces
      --exclude-current-workspace  Run the subcommand on each workspace other than the current workspace
      --workspace                  Run the subcommand for all packages in the workspace
  -p, --package <PACKAGE>          Package name to run the subcommand for
  -h, --help                       Print help information

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

env_args: EnvArgs

Environment variables to set for cargo fmt.

package_args: PackageArgs

Packages to run the cargo fmt for

extra_options: Vec<String>

Options to pass to the cargo fmt

Implementations

impl Fmt

pub fn run(&self, _config: &Config<'_>) -> Result<()>

Runs the fmt subcommand.

Trait Implementations

impl Args for Fmt

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.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl Clone for Fmt

fn clone(&self) -> Fmt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fmt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Fmt

fn default() -> Fmt

Returns the “default value” for a type.

impl FromArgMatches for Fmt

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 Run for Fmt

fn run(&self, config: &Config<'_>) -> Result<()>

Runs the command or subcommand.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Converts the Box<dyn Run> to Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Converts the &dyn Run trait object to a concrete type.

fn as_any_mut(&mut self) -> &mut dyn Any

Converts the &dyn Run trait object to a mutable concrete type.

fn to_subcommands(&self) -> Option<SubcommandRun>

Returns the subcommands that this command will run.