Struct SecretsLoadResult 

pub struct SecretsLoadResult {
    pub scanner: StreamScanner,
    pub warnings: Vec<(usize, SanitizeError)>,
    pub allow_patterns: Vec<String>,
}

Result of loading a secrets file into a StreamScanner.

Returned by StreamScanner::from_encrypted_secrets and StreamScanner::from_plaintext_secrets.

The #[must_use] attribute guards against silently discarding allow_patterns, which would cause values that should be suppressed to be sanitized instead.

Example

let SecretsLoadResult { scanner, warnings, allow_patterns } =
    StreamScanner::from_plaintext_secrets(bytes, None, store, config, vec![])?;

for (idx, err) in &warnings {
    eprintln!("secrets entry {idx} failed to compile: {err}");
}

let (allowlist, al_warnings) = AllowlistMatcher::new(allow_patterns).into_parts();
let store = MappingStore::new_with_allowlist(gen, None, Arc::new(allowlist));

Fields

scanner: StreamScanner

The compiled scanner, ready to use.

warnings: Vec<(usize, SanitizeError)>

Secrets-file entries that failed pattern compilation: (index_in_file, error). A non-empty list means some patterns were silently skipped and the scanner covers less than the full file.

allow_patterns: Vec<String>

Raw strings from kind: allow entries in the secrets file. Pass these to crate::allowlist::AllowlistMatcher::new and attach the resulting matcher to a crate::store::MappingStore via crate::store::MappingStore::new_with_allowlist.