Struct MutationRunOptions 

pub struct MutationRunOptions {

    pub analysis: AnalysisOptions,
    pub scope: MutationRunScope,
    pub operators: Option<Vec<Operator>>,
    pub allow_side_effects: bool,
    pub max_mutants: Option<usize>,
    pub allow_dirty: bool,
    pub runtime: Option<PathBuf>,
    pub concurrency: Option<usize>,
    pub time_budget: Option<Duration>,
    pub runner_timeout: Option<Duration>,
    pub runner_config: Option<PathBuf>,
    pub output_paths: Vec<PathBuf>,
    pub typecheck: bool,
}

Options of crate::run_mutation and crate::plan_mutation.

Fields

analysis: AnalysisOptions

Shared project, config and cache options.

scope: MutationRunScope

The code to mutate.

operators: Option<Vec<Operator>>

The operators to use. None uses each operator.

allow_side_effects: bool

Keep mutants near a file system, process, network or database sink. Only an explicit caller option can set this, never project config, because the run has no sandbox copy.

max_mutants: Option<usize>

The maximum number of covered mutants to run, in rank order. A mutant that no dry-run test covers is no_coverage and does not count. The others become pending.

allow_dirty: bool

Run in a dirty git worktree, or outside a git worktree. The run still compares the worktree after the run.

runtime: Option<PathBuf>

The JavaScript runtime. None uses the runtime of the runner from PATH: node for node:test, bun for bun test, and node, then bun, for Vitest.

concurrency: Option<usize>

The number of companion processes. None uses half the logical cores.

time_budget: Option<Duration>

The time budget of the run. Mutants that did not start before it ends become pending.

runner_timeout: Option<Duration>

The timeout of the companion init and the dry run. None uses 120 seconds.

runner_config: Option<PathBuf>

The config file of the test runner, for example a separate Vitest config of the integration tests. A relative path is relative to the project root. The file must exist inside the project root. None uses the mutation.runnerConfig config key, else the default config discovery of the runner. Only the Vitest runner reads a config file.

output_paths: Vec<PathBuf>

The files that the caller writes after the run, for example the --output-file report. The worktree check leaves them out, so an old report does not make the worktree dirty. A relative path is relative to the process directory, as the caller writes it.

typecheck: bool

Type-check each survived mutant through the TypeScript-Go companion of --type-aware. A survivor whose mutated file does not type-check becomes compile_error and leaves the score. The run fails before the tests start when no trusted companion exists.

Trait Implementations

impl Clone for MutationRunOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MutationRunOptions

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

Formats the value using the given formatter.

impl Default for MutationRunOptions

fn default() -> Self

Returns the “default value” for a type.