Struct CaptureConfig 

pub struct CaptureConfig {
    pub path: PathBuf,
    pub redact: bool,
    pub queue: usize,
    pub hep: Option<HepConfig>,
}

How a capture is configured (Config::capture).

Fields

path: PathBuf

Where to write the pcapng file. Created, or truncated if it exists.

redact: bool

Whether to strip credentials before writing (§13.3). On by default.

Turning it off is for a lab capture against a test registrar, where there is no secret worth removing and redaction would hide the digest bug the capture was taken to find. Never turn it off for a capture that will leave the machine.

queue: usize

How many records may queue for the writer before records are dropped.

Dropped rather than blocking the driver: see the module note. A dropped record is counted in crate::CaptureCounts::dropped, never silent.

hep: Option<HepConfig>

Optional HEP3 export of the same redacted records written to the pcapng file.

HEP is always best effort: the collector socket is non-blocking and failures increment crate::CaptureCounts::hep_dropped without failing the endpoint or the call. A HEP export may not be combined with Self::without_redaction.

Implementations

impl CaptureConfig

pub fn new(path: impl Into<PathBuf>) -> Self

A redacting capture at path, with a queue deep enough for a burst.

pub fn with_hep(self, hep: HepConfig) -> Self

Send each redacted capture record to a HEP3 collector as well as the pcapng file.

pub fn without_redaction(self) -> Self

Keep credentials in the file.

Named so that it cannot be reached without saying what it does at the call site.

Trait Implementations

impl Clone for CaptureConfig

fn clone(&self) -> CaptureConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CaptureConfig

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

Formats the value using the given formatter.