Struct ScanConfig 

pub struct ScanConfig {
    pub chunk_size: usize,
    pub overlap_size: usize,
}

Configuration for the streaming scanner.

Tuning Guide

Workload	chunk_size	overlap_size
Small files (< 10 MB)	256 KiB	1 KiB
General purpose	1 MiB	4 KiB
Large files (> 1 GB)	4–8 MiB	8 KiB
Memory-constrained	64 KiB	1 KiB

overlap_size should be ≥ the longest expected match. Most secret patterns (API keys, emails, SSNs) are well under 256 bytes, so the 4 KiB default provides ample margin.

Fields

chunk_size: usize

Size of each chunk read from the input (bytes).

Larger chunks improve throughput (fewer syscalls) but use more memory. Default: 1 MiB.

overlap_size: usize

Overlap between consecutive chunks (bytes).

Must be ≥ the maximum expected match length. Patterns whose matches can exceed this length risk being missed at chunk boundaries. Default: 4 KiB.

Implementations

impl ScanConfig

pub fn new(chunk_size: usize, overlap_size: usize) -> Self

Create a new configuration with explicit values.

pub fn validate(&self) -> Result<()>

Validate the configuration, returning an error if invalid.

Errors

Returns SanitizeError::InvalidConfig if chunk_size is zero or overlap_size >= chunk_size.

Trait Implementations

impl Clone for ScanConfig

fn clone(&self) -> ScanConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanConfig

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

Formats the value using the given formatter.

impl Default for ScanConfig

fn default() -> Self

Returns the “default value” for a type.