Struct AnalysisOptions 

pub struct AnalysisOptions {

    pub root: Option<PathBuf>,
    pub config_path: Option<PathBuf>,
    pub allow_remote_extends: bool,
    pub no_cache: bool,
    pub threads: Option<usize>,
    pub diff_file: Option<PathBuf>,
    pub ambient_diff_file: Option<PathBuf>,
    pub production: bool,
    pub production_override: Option<bool>,
    pub changed_since: Option<String>,
    pub ambient_changed_since: Option<String>,
    pub workspace: Option<Vec<String>>,
    pub changed_workspaces: Option<String>,
    pub explain: bool,
    pub type_aware: TypeAwareOptions,
    pub cancellation: Option<Arc<AtomicBool>>,
}

Shared options for all one-shot analyses.

Fields

root: Option<PathBuf>

Project root to analyze. None resolves to the current working directory.

config_path: Option<PathBuf>

Explicit config file path. None uses config discovery from the root.

allow_remote_extends: bool

Permit https:// config inheritance for this analysis call.

no_cache: bool

Bypass the on-disk analysis cache for this call.

threads: Option<usize>

Worker thread count. None picks the default; Some(0) is rejected.

diff_file: Option<PathBuf>

Explicit unified diff file that scopes changed-code analysis.

A file that cannot be read fails the call with FALLOW_INVALID_DIFF_FILE: the caller named it and can fix it.

ambient_diff_file: Option<PathBuf>

Unified diff file inherited from the environment (FALLOW_DIFF_FILE) rather than named by the caller. Read only when diff_file is unset.

A file that cannot be read or placed does not fail the call. The analysis runs at full scope and request_outcomes["diff-filter"] states the reason, exactly as the CLI does for the same variable: a caller cannot fix a CI environment it inherited (issue #2799).

production: bool

Legacy convenience override. true forces production mode; false defers to config unless production_override is set.

production_override: Option<bool>

Explicit production override from an embedder option. None means use the project config for the current analysis.

changed_since: Option<String>

Git base reference that scopes analysis to files changed since it.

A ref that does not resolve fails the call with FALLOW_CHANGED_FILES_FAILED: the caller named it and can fix it.

ambient_changed_since: Option<String>

Git base reference inherited from the environment (FALLOW_CHANGED_SINCE) rather than named by the caller. Read only when changed_since is unset.

A ref that does not resolve does not fail the call. The analysis runs at full scope and request_outcomes["changed-since"] states the reason, exactly as the CLI does for --changed-since.

workspace: Option<Vec<String>>

Restrict analysis to the named workspace packages.

changed_workspaces: Option<String>

Restrict analysis to workspaces changed since the given git reference.

explain: bool

Include rule and metric explanations (_meta) in machine output.

type_aware: TypeAwareOptions

Optional project-wide TypeScript semantic analysis. Disabled by default and never changes compiler or typed-lint ownership.

cancellation: Option<Arc<AtomicBool>>

Caller-owned cooperative cancellation for this analysis.

Setting the flag asks the analysis to stop at its next stage boundary and return a FALLOW_CANCELLED error. None, the default, is an analysis that always runs to completion.

The field is on the shared options struct, but the entry points do not all honor it, so read the one being called before relying on it:

• Cancelled at the entry, on both sides of the per-file parse loop, and at each pipeline stage boundary: run_dead_code, run_circular_dependencies, run_boundary_violations, run_combined, run_duplication, run_feature_flags, and the four trace routes.
• Cancelled only at the boundaries around config load and file discovery, because they are the whole run: run_project_info and run_list_boundaries.
• Cancelled only at the entry, then run to completion: run_health, which hands off to a runner that builds its own session below these options.
• Not cancellable at all: run_decision_surface and run_similar_code.

The stop is cooperative everywhere it exists, so it has no upper bound: it is only as prompt as the longest stage holding no check, and duplication detection and the dead-code detectors are each seconds of uninterruptible work on a large repository. A caller that needs a bounded stop has to run Fallow as a child process and kill it.

Trait Implementations

impl Clone for AnalysisOptions

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 AnalysisOptions

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

Formats the value using the given formatter.

impl Default for AnalysisOptions

fn default() -> Self

Returns the “default value” for a type.