Struct cargo_tarpaulin::args::ConfigArgs

pub struct ConfigArgs {

    pub logging: LoggingArgs,
    pub run_types: RunTypesArgs,
    pub config: Option<PathBuf>,
    pub ignore_config: bool,
    pub bin: Vec<String>,
    pub example: Vec<String>,
    pub test: Vec<String>,
    pub bench: Vec<String>,
    pub no_fail_fast: bool,
    pub profile: Option<String>,
    pub ignore_tests: bool,
    pub no_dead_code: bool,
    pub include_tests: bool,
    pub ignore_panics: bool,
    pub count: bool,
    pub ignored: bool,
    pub line: bool,
    pub skip_clean: bool,
    pub force_clean: bool,
    pub fail_under: Option<f64>,
    pub branch: bool,
    pub forward: bool,
    pub coveralls: Option<String>,
    pub report_uri: Option<String>,
    pub no_default_features: bool,
    pub features: Vec<String>,
    pub all_features: bool,
    pub all: bool,
    pub workspace: bool,
    pub packages: Vec<String>,
    pub exclude: Vec<String>,
    pub exclude_files: Vec<Pattern>,
    pub timeout: Option<u64>,
    pub post_test_delay: Option<u64>,
    pub follow_exec: bool,
    pub release: bool,
    pub no_run: bool,
    pub implicit_test_threads: bool,
    pub locked: bool,
    pub frozen: bool,
    pub target: Option<String>,
    pub target_dir: Option<PathBuf>,
    pub offline: bool,
    pub avoid_cfg_tarpaulin: bool,
    pub jobs: Option<usize>,
    pub rustflags: Option<String>,
    pub objects: Vec<PathBuf>,
    pub unstable_features: Vec<String>,
    pub out: Vec<OutputFile>,
    pub engine: Option<TraceEngine>,
    pub output_dir: Option<PathBuf>,
    pub command: Option<Mode>,
    pub root: Option<PathBuf>,
    pub manifest_path: Option<PathBuf>,
    pub ciserver: Option<Ci>,
    pub fail_immediately: bool,
    pub args: Vec<String>,
}

Fields

logging: LoggingArgs

run_types: RunTypesArgs

config: Option<PathBuf>

Path to a toml file specifying a list of options this will override any other options set

ignore_config: bool

Ignore any project config files

bin: Vec<String>

Test only the specified binary

example: Vec<String>

Test only the specified example

test: Vec<String>

Test only the specified test target

bench: Vec<String>

Test only the specified bench target

no_fail_fast: bool

Run all tests regardless of failure

profile: Option<String>

Build artefacts with the specified profile

ignore_tests: bool

Ignore lines of test functions when collecting coverage (default)

no_dead_code: bool

Stops tarpaulin from building projects with -Clink-dead-code

include_tests: bool

Include lines of test functions when collecting coverage

ignore_panics: bool

Ignore panic macros in tests

count: bool

Counts the number of hits during coverage

ignored: bool

Run ignored tests as well

line: bool

Line coverage

skip_clean: bool

The opposite of –force-clean

force_clean: bool

Adds a clean stage to work around cargo bugs that may affect coverage results

fail_under: Option<f64>

Sets a percentage threshold for failure ranging from 0-100, if coverage is below exit with a non-zero code

branch: bool

Branch coverage: NOT IMPLEMENTED

forward: bool

Forwards unexpected signals to test. This is now the default behaviour

coveralls: Option<String>

Coveralls key, either the repo token, or if you’re using travis use $TRAVIS_JOB_ID and specify travis-{ci|pro} in –ciserver

report_uri: Option<String>

URI to send report to, only used if the option –coveralls is used

no_default_features: bool

Do not include default features

features: Vec<String>

Features to be included in the target project

all_features: bool

Build all available features

all: bool

Alias for –workspace (deprecated)

workspace: bool

Test all packages in the workspace

packages: Vec<String>

Package id specifications for which package should be build. See cargo help pkgid for more info

exclude: Vec<String>

Package id specifications to exclude from coverage. See cargo help pkgid for more info

exclude_files: Vec<Pattern>

Exclude given files from coverage results has * wildcard

timeout: Option<u64>

Integer for the maximum time in seconds without response from test before timeout (default is 1 minute).

post_test_delay: Option<u64>

Delay after test to collect coverage profiles

follow_exec: bool

Follow executed processes capturing coverage information if they’re part of your project.

release: bool

Build in release mode.

no_run: bool

Compile tests but don’t run coverage

implicit_test_threads: bool

’Don’t supply an explicit --test-threads argument to test executable. By default tarpaulin will infer the default rustc would pick if not ran via tarpaulin and set it

locked: bool

Do not update Cargo.lock

frozen: bool

Do not update Cargo.lock or any caches

target: Option<String>

Compilation target triple

target_dir: Option<PathBuf>

Directory for all generated artifacts

offline: bool

Run without accessing the network

avoid_cfg_tarpaulin: bool

Remove –cfg=tarpaulin from the RUSTFLAG

jobs: Option<usize>

Number of parallel jobs, defaults to # of CPUs

rustflags: Option<String>

Rustflags to add when building project (can also be set via RUSTFLAGS env var)

objects: Vec<PathBuf>

Other object files to load which contain information for llvm coverage - must have been compiled with llvm coverage instrumentation (ignored for ptrace)

unstable_features: Vec<String>

List of unstable nightly only flags

out: Vec<OutputFile>

Output format of coverage report

engine: Option<TraceEngine>

Coverage tracing backend to use

output_dir: Option<PathBuf>

Specify a custom directory to write report files

command: Option<Mode>

cargo subcommand to run. So far only test and build are supported

root: Option<PathBuf>

Calculates relative paths to root directory. If –manifest-path isn’t specified it will look for a Cargo.toml in root

manifest_path: Option<PathBuf>

Path to Cargo.toml

ciserver: Option<Ci>

CI server being used, if unspecified tarpaulin may automatically infer for coveralls uploads

fail_immediately: bool

Option to fail immediately after a single test fails

args: Vec<String>

Arguments to be passed to the test executables can be used to filter or skip certain tests

Trait Implementations

impl Args for ConfigArgs

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 ConfigArgs

fn clone(&self) -> ConfigArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigArgs

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

Formats the value using the given formatter.

impl From<ConfigArgs> for ConfigWrapper

fn from(args: ConfigArgs) -> Self

Converts to this type from the input type.

impl FromArgMatches for ConfigArgs

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.