Struct PiiAttachmentsProcessor

pub struct PiiAttachmentsProcessor<'a> { /* private fields */ }

A PII processor for attachment files.

Implementations

impl<'a> PiiAttachmentsProcessor<'a>

pub fn new(compiled_config: &'a CompiledPiiConfig) -> Self

Creates a new PiiAttachmentsProcessor from the given PII config.

pub fn scrub_attachment(&self, filename: &str, data: &mut [u8]) -> bool

Applies PII scrubbing rules to a plain attachment.

Returns true, if the attachment was modified.

pub fn scrub_utf8_filepath( &self, path: &mut str, state: &ProcessingState<'_>, ) -> bool

Scrub a filepath, preserving the basename.

pub fn scrub_utf16_filepath( &self, path: &mut WStr<LittleEndian>, state: &ProcessingState<'_>, ) -> bool

Scrub a filepath, preserving the basename.

pub fn scrub_json(&self, payload: &[u8]) -> Result<Vec<u8>, JsonScrubError>

Applies PII rules to the given JSON.

This function will perform PII scrubbing using serde_transcode, which means that it does not have to read the entire document in memory but will rather perform in on a per-item basis using a streaming approach.

Returns a scrubbed copy of the JSON document.

impl PiiAttachmentsProcessor<'_>

pub fn scrub_minidump( &self, filename: &str, data: &mut [u8], ) -> Result<bool, ScrubMinidumpError>

Applies PII rules to the given minidump.

This function selectively opens minidump streams in order to avoid destroying the stack memory required for minidump processing. It visits:

1. All stack memory regions with ValueType::StackMemory
2. All other memory regions with ValueType::HeapMemory
3. Linux auxiliary streams with ValueType::Binary

Returns true, if the minidump was modified.