Struct Arguments

pub struct Arguments {

    pub include_ignored: bool,
    pub ignored: bool,
    pub exclude_should_panic: bool,
    pub test: bool,
    pub bench: bool,
    pub list: bool,
    pub logfile: Option<String>,
    pub nocapture: bool,
    pub test_threads: Option<usize>,
    pub skip: Vec<String>,
    pub quiet: bool,
    pub exact: bool,
    pub color: Option<ColorSetting>,
    pub format: Option<FormatSetting>,
    pub show_output: bool,
    pub unstable_flags: Option<UnstableFlags>,
    pub report_time: bool,
    pub ensure_time: bool,
    pub shuffle: bool,
    pub shuffle_seed: Option<u64>,
    pub filter: Option<String>,
    pub ipc: Option<String>,
    pub spawn_workers: bool,
}

Command line arguments.

This type represents everything the user can specify via CLI args. The main method is from_args which reads the global std::env::args() and parses them into this type.

Fields

include_ignored: bool

Run ignored and not ignored tests

ignored: bool

Run only ignored tests

exclude_should_panic: bool

Excludes tests marked as should_panic

test: bool

Run tests and not benchmarks

bench: bool

Run benchmarks instead of tests

list: bool

List all tests and benchmarks

logfile: Option<String>

Write logs to the specified file

nocapture: bool

don’t capture stdout/stderr of each task, allow printing directly

test_threads: Option<usize>

Number of threads used for running tests in parallel

skip: Vec<String>

Skip tests whose names contains FILTER (this flag can be used multiple times)

quiet: bool

Display one character per test instead of one line. Alias to --format=terse

exact: bool

Exactly match filters rather than by substring

color: Option<ColorSetting>

Configure coloring of output

format: Option<FormatSetting>

Configure formatting of output

show_output: bool

Show captured stdout of successful tests

unstable_flags: Option<UnstableFlags>

Enable nightly-only flags

report_time: bool

Show execution time of each test. Threshold values for colorized output can be configured via RUST_TEST_TIME_UNIT, RUST_TEST_TIME_INTEGRATION and RUST_TEST_TIME_DOCTEST environment variables. Expected format of the environment variables is VARIABLE=WARN_TIME,CRITICAL_TIME. Durations must be specified in milliseconds, e.g. 500,2000 means that the warn time is 0.5 seconds, and the critical time is 2 seconds. Not available for --format=terse.

ensure_time: bool

Treat excess of the test execution time limit as error. Threshold values for this option can be configured via RUST_TEST_TIME_UNIT, RUST_TEST_TIME_INTEGRATION and RUST_TEST_TIME_DOCTEST environment variables. Expected format of the environment variables is VARIABLE=WARN_TIME,CRITICAL_TIME. CRITICAL_TIME here means the limit that should not be exceeded by test.

shuffle: bool

Run tests in random order

shuffle_seed: Option<u64>

Run tests in random order; seed the random number generator with SEED

filter: Option<String>

The FILTER string is tested against the name of all tests, and only those tests whose names contain the filter are run. Multiple filter strings may be passed, which will run all tests matching any of the filters.

ipc: Option<String>

Run the test suite in worker IPC mode - listening on the given local socket waiting for the test runner to connect and send test execution requests. The only stdout/stderr output will be the one emitted by the actual test runs so the test runner can capture them.

spawn_workers: bool

If true, spawn worker processes in IPC mode and run the tests on those

Implementations

impl Arguments

pub fn from_args() -> Arguments

Parses the global CLI arguments given to the application.

If the parsing fails (due to incorrect CLI args), an error is shown and the application exits. If help is requested (-h or --help), a help message is shown and the application exits, too.

pub fn to_args(&self) -> Vec<OsString>

Renders the arguments as a list of strings that can be passed to a subprocess

pub fn unit_test_threshold(&self) -> TimeThreshold

pub fn integration_test_threshold(&self) -> TimeThreshold

Trait Implementations

impl Args for Arguments

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 Arguments

fn clone(&self) -> Arguments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Arguments

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 Arguments

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

Formats the value using the given formatter.

impl Default for Arguments

fn default() -> Arguments

Returns the “default value” for a type.

impl FromArgMatches for Arguments

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Arguments, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Arguments, 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<A> FromIterator<A> for Arguments

where A: Into<OsString> + Clone,

fn from_iter<T>(iter: T) -> Arguments

where T: IntoIterator<Item = A>,

Creates a value from an iterator.

impl Parser for Arguments

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.