Enum Subcommand

pub enum Subcommand {
    Build,
    Check {
        all_targets: bool,
    },
    Clippy {
        fix: bool,
        allow_dirty: bool,
        allow_staged: bool,
        allow: Vec<String>,
        deny: Vec<String>,
        warn: Vec<String>,
        forbid: Vec<String>,
    },
    Fix,
    Format {
        check: bool,
        all: bool,
    },
    Doc {
        open: bool,
        json: bool,
    },
    Test {

        no_fail_fast: bool,
        test_args: Vec<String>,
        compiletest_rustc_args: Vec<String>,
        no_doc: bool,
        doc: bool,
        bless: bool,
        extra_checks: Option<String>,
        force_rerun: bool,
        only_modified: bool,
        compare_mode: Option<String>,
        pass: Option<String>,
        run: Option<String>,
        rustfix_coverage: bool,
    
},
    Miri {
        no_fail_fast: bool,
        test_args: Vec<String>,
        no_doc: bool,
        doc: bool,
    },
    Bench {
        test_args: Vec<String>,
    },
    Clean {
        all: bool,
        stage: Option<u32>,
    },
    Dist,
    Install,
    Run {
        args: Vec<String>,
    },
    Setup {
        profile: Option<PathBuf>,
    },
    Suggest {
        run: bool,
    },
    Vendor {
        sync: Vec<PathBuf>,
        versioned_dirs: bool,
    },
    Perf {},
}

Variants

Build

Compile either the compiler or libraries

Check

Compile either the compiler or libraries, using cargo check

Fields

all_targets: bool

Check all targets

Clippy

Run Clippy (uses rustup/cargo-installed clippy binary)

Fields

fix: bool

allow_dirty: bool

allow_staged: bool

allow: Vec<String>

clippy lints to allow

deny: Vec<String>

clippy lints to deny

warn: Vec<String>

clippy lints to warn on

forbid: Vec<String>

clippy lints to forbid

Fix

Run cargo fix

Format

Run rustfmt

Fields

check: bool

check formatting instead of applying

all: bool

apply to all appropriate files, not just those that have been modified

Doc

Build documentation

Fields

open: bool

open the docs in a browser

json: bool

render the documentation in JSON format in addition to the usual HTML format

Test

Build and run some test suites

Fields

no_fail_fast: bool

run all tests regardless of failure

test_args: Vec<String>

extra arguments to be passed for the test tool being used (e.g. libtest, compiletest or rustdoc)

compiletest_rustc_args: Vec<String>

extra options to pass the compiler when running compiletest tests

no_doc: bool

do not run doc tests

doc: bool

only run doc tests

bless: bool

whether to automatically update stderr/stdout files

extra_checks: Option<String>

comma-separated list of other files types to check (accepts py, py:lint, py:fmt, shell)

force_rerun: bool

rerun tests even if the inputs are unchanged

only_modified: bool

only run tests that result has been changed

compare_mode: Option<String>

mode describing what file the actual ui output will be compared to

pass: Option<String>

force {check,build,run}-pass tests to this mode.

run: Option<String>

whether to execute run-* tests

rustfix_coverage: bool

enable this to generate a Rustfix coverage file, which is saved in /<build_base>/rustfix_missing_coverage.txt

Miri

Build and run some test suites in Miri

Fields

no_fail_fast: bool

run all tests regardless of failure

test_args: Vec<String>

extra arguments to be passed for the test tool being used (e.g. libtest, compiletest or rustdoc)

no_doc: bool

do not run doc tests

doc: bool

only run doc tests

Bench

Build and run some benchmarks

Fields

test_args: Vec<String>

Clean

Clean out build directories

Fields

all: bool

Clean the entire build directory (not used by default)

stage: Option<u32>

Clean a specific stage without touching other artifacts. By default, every stage is cleaned if this option is not used.

Dist

Build distribution artifacts

Install

Install distribution artifacts

Run

Run tools contained in this repository

Fields

args: Vec<String>

arguments for the tool

Setup

Set up the environment for development

Fields

profile: Option<PathBuf>

Either the profile for config.toml or another setup action. May be omitted to set up interactively

Suggest

Suggest a subset of tests to run, based on modified files

Fields

run: bool

run suggested tests

Vendor

Vendor dependencies

Fields

sync: Vec<PathBuf>

Additional Cargo.toml to sync and vendor

versioned_dirs: bool

Always include version in subdir name

Perf

Perform profiling and benchmarking of the compiler using the rustc-perf-wrapper tool.

You need to pass arguments after --, e.g.x perf -- cachegrind.

Implementations

impl Subcommand

pub fn kind(&self) -> Kind

pub fn compiletest_rustc_args(&self) -> Vec<&str>

pub fn fail_fast(&self) -> bool

pub fn doc_tests(&self) -> DocTests

pub fn bless(&self) -> bool

pub fn extra_checks(&self) -> Option<&str>

pub fn only_modified(&self) -> bool

pub fn force_rerun(&self) -> bool

pub fn rustfix_coverage(&self) -> bool

pub fn compare_mode(&self) -> Option<&str>

pub fn pass(&self) -> Option<&str>

pub fn run(&self) -> Option<&str>

pub fn open(&self) -> bool

pub fn json(&self) -> bool

pub fn vendor_versioned_dirs(&self) -> bool

pub fn vendor_sync_args(&self) -> Vec<PathBuf>

Trait Implementations

impl Clone for Subcommand

fn clone(&self) -> Subcommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subcommand

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

Formats the value using the given formatter.

impl Default for Subcommand

fn default() -> Subcommand

Returns the “default value” for a type.

impl FromArgMatches for Subcommand

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Subcommand

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

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 152 bytes

Size for each variant:

• Build: 0 bytes
• Check: 9 bytes
• Clippy: 112 bytes
• Fix: 0 bytes
• Format: 10 bytes
• Doc: 10 bytes
• Test: 152 bytes
• Miri: 40 bytes
• Bench: 32 bytes
• Clean: 20 bytes
• Dist: 0 bytes
• Install: 0 bytes
• Run: 32 bytes
• Setup: 32 bytes
• Suggest: 9 bytes
• Vendor: 40 bytes
• Perf: 0 bytes