Struct ScannerConfig 

pub struct ScannerConfig {

    pub max_decode_depth: usize,
    pub validate_decode: bool,
    pub entropy_enabled: bool,
    pub entropy_threshold: f64,
    pub entropy_in_source_files: bool,
    pub ml_enabled: bool,
    pub ml_weight: f64,
    pub min_confidence: f64,
    pub unicode_normalization: bool,
    pub max_decode_bytes: usize,
    pub max_matches_per_chunk: usize,
    pub scan_comments: bool,
    pub multiline: MultilineConfig,
    pub known_prefixes: Vec<String>,
    pub secret_keywords: Vec<String>,
    pub test_keywords: Vec<String>,
    pub placeholder_keywords: Vec<String>,
}

Configuration for the scanner’s decoding and processing heuristics.

Fields

max_decode_depth: usize

Maximum recursion depth for decode-through (base64, hex, etc.)

validate_decode: bool

Validate decoded strings (e.g. check if decoded base64 is UTF-8)

entropy_enabled: bool

Enable entropy-based detection

entropy_threshold: f64

Threshold for entropy-based detection

entropy_in_source_files: bool

Enable entropy-based detection in source code files

ml_enabled: bool

Enable ML-based confidence scoring

ml_weight: f64

ML weight for confidence scoring, 0.0-1.0

min_confidence: f64

Minimum confidence threshold for matches

unicode_normalization: bool

Enable Unicode normalization

max_decode_bytes: usize

Maximum bytes for decode-through processing

max_matches_per_chunk: usize

Maximum matches to collect per chunk before stopping. Prevents OOM on extremely noisy files.

scan_comments: bool

When true, credentials inside source-code comments are treated as first-class findings (no confidence downgrade, no comment-context multiplier). Mirrors keyhog_core::config::ScanConfig::scan_comments and the CLI’s --scan-comments flag. See that field’s doc for why the default is off.

multiline: MultilineConfig

Configuration for multiline concatenation

known_prefixes: Vec<String>

Known secret prefixes used to boost confidence.

secret_keywords: Vec<String>

Keywords indicating a secret context (e.g. “api_key”, “token”).

test_keywords: Vec<String>

Keywords indicating a test/mock context (e.g. “test”, “fake”).

placeholder_keywords: Vec<String>

Keywords indicating a placeholder value (e.g. “change_me”, “todo”).

Implementations

impl ScannerConfig

pub fn fast() -> Self

pub fn thorough() -> Self

pub fn min_confidence(self, min_confidence: f64) -> Self

pub fn sanitise(&mut self)

Clamp every float field into its valid range and replace any NaN with a safe default. A user-supplied --min-confidence=-5.0 or a corrupt config TOML feeding min_confidence = nan would otherwise NaN-infect the confidence-comparison path and silently drop every finding (NaN comparisons are always false, so conf < min_confidence is false, but conf >= min_confidence is also false, behaviour-dependent on the call site).

Idempotent - sanitising an already-sane config is a no-op. Called inside From<ScanConfig> so any path that constructs a ScannerConfig from a user-influenced source pays this once at config-build time.

Trait Implementations

impl Clone for ScannerConfig

fn clone(&self) -> ScannerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScannerConfig

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

Formats the value using the given formatter.

impl Default for ScannerConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<ScanConfig> for ScannerConfig

fn from(config: ScanConfig) -> Self

Converts to this type from the input type.