Struct ScanOptions 

pub struct ScanOptions {

    pub progress_mode: ProgressMode,
    pub process_mode: ProcessMode,
    pub timeout_seconds: f64,
    pub max_depth: usize,
    pub max_in_memory: MemoryMode,
    pub collect_info: bool,
    pub detect_license: LicenseSource,
    pub detect_packages: bool,
    pub detect_system_packages: bool,
    pub detect_packages_in_compiled: bool,
    pub package_only: bool,
    pub no_assemble: bool,
    pub detect_copyrights: bool,
    pub detect_emails: bool,
    pub detect_urls: bool,
    pub detect_generated: bool,
    pub max_emails: usize,
    pub max_urls: usize,
    pub include: Vec<String>,
    pub exclude: Vec<String>,
    pub include_input_header: bool,
    pub cache_dir: Option<PathBuf>,
    pub cache_clear: bool,
    pub incremental: bool,
    pub cache_trust_mtime: bool,
    pub reindex: bool,
    pub no_license_index_cache: bool,
    pub license_text: bool,
    pub license_text_diagnostics: bool,
    pub license_diagnostics: bool,
    pub unknown_licenses: bool,
    pub no_sequence_matching: bool,
    pub license_score: u8,
    pub filter_clues: bool,
    pub ignore_author_patterns: Vec<String>,
    pub ignore_copyright_holder_patterns: Vec<String>,
    pub only_findings: bool,
    pub mark_source: bool,
    pub classify: bool,
    pub summary: bool,
    pub license_clarity_score: bool,
    pub license_references: bool,
    pub license_url_template: String,
    pub license_policy: Option<PathBuf>,
    pub tallies: bool,
    pub tallies_key_files: bool,
    pub tallies_with_details: bool,
    pub facets: Vec<String>,
    pub tallies_by_facet: bool,
    pub strip_root: bool,
    pub full_root: bool,
    pub header_options: Map<String, Value>,
    pub max_files: Option<usize>,
    pub max_total_bytes: Option<u64>,
    pub scan_deadline_seconds: Option<f64>,
    pub restrict_out_of_tree_symlinks: bool,
}

High-level configuration for in-process scans through scan_path and scan_paths.

Defaults stay intentionally conservative: progress is quiet, no scan dimensions are enabled, input headers are omitted, and ambient PROVENANT_CACHE is ignored unless you set ScanOptions::cache_dir.

Fields

progress_mode: ProgressMode

process_mode: ProcessMode

timeout_seconds: f64

max_depth: usize

max_in_memory: MemoryMode

collect_info: bool

detect_license: LicenseSource

detect_packages: bool

detect_system_packages: bool

detect_packages_in_compiled: bool

package_only: bool

no_assemble: bool

detect_copyrights: bool

detect_emails: bool

detect_urls: bool

detect_generated: bool

max_emails: usize

max_urls: usize

include: Vec<String>

exclude: Vec<String>

include_input_header: bool

cache_dir: Option<PathBuf>

cache_clear: bool

incremental: bool

cache_trust_mtime: bool

Opt-in trust-mtime mode for warm incremental scans.

When true, a cached entry is reused on a size + mtime fingerprint match without re-reading and re-hashing the file. Default false keeps the paranoid full-hash behavior so default scans stay byte-identical.

reindex: bool

no_license_index_cache: bool

license_text: bool

license_text_diagnostics: bool

license_diagnostics: bool

unknown_licenses: bool

no_sequence_matching: bool

license_score: u8

filter_clues: bool

ignore_author_patterns: Vec<String>

ignore_copyright_holder_patterns: Vec<String>

only_findings: bool

mark_source: bool

classify: bool

summary: bool

license_clarity_score: bool

license_references: bool

license_url_template: String

license_policy: Option<PathBuf>

tallies: bool

tallies_key_files: bool

tallies_with_details: bool

facets: Vec<String>

tallies_by_facet: bool

strip_root: bool

full_root: bool

header_options: Map<String, Value>

max_files: Option<usize>

Maximum number of files to collect before the walk stops, if any.

Untrusted callers (such as provenant serve) set finite ceilings to bound denial-of-service exposure; trusted scans leave these unset.

max_total_bytes: Option<u64>

Maximum cumulative size of collected files in bytes, if any.

scan_deadline_seconds: Option<f64>

Overall wall-clock budget for the collection pass in seconds, if any.

restrict_out_of_tree_symlinks: bool

When true, file symlinks whose target escapes the scan root are skipped instead of being dereferenced and scanned.

Trait Implementations

impl Clone for ScanOptions

fn clone(&self) -> ScanOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanOptions

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

Formats the value using the given formatter.

impl Default for ScanOptions

fn default() -> Self

Returns the “default value” for a type.