Enum AuditSink 

pub enum AuditSink {
    Disabled,
    File {
        path: PathBuf,
        max_bytes: Option<u64>,
        state: Mutex<FileState>,
    },
}

Where audit events go.

Disabled unless a path is configured: writing to a file nobody asked for would be a surprising side effect, and the operator is the one who knows where such a file belongs.

Variants

Disabled

Nothing is recorded.

File

Appended to a file, one JSON object per line.

Fields

path: PathBuf

Path being appended to, kept for diagnostics.

max_bytes: Option<u64>

Size at which the file is rotated, if bounded.

state: Mutex<FileState>

Implementations

impl AuditSink

pub fn file(path: impl AsRef<Path>) -> Result<Self>

Open path for appending, creating it if needed.

pub fn file_with_limit( path: impl AsRef<Path>, max_bytes: Option<u64>, ) -> Result<Self>

Open path, rotating to <path>.1 once it passes max_bytes.

One generation is kept. A trail that grows without bound eventually fills the disk it is meant to protect, and keeping several generations would be a retention policy — which belongs to whoever runs the machine, not to this process.

pub fn is_enabled(&self) -> bool

Whether anything is being recorded.

pub fn record(&self, event: AuditEvent)

Record one event.

Flushed per event rather than buffered until convenient: a trail that loses its last entries when the process dies is least trustworthy exactly when it matters most.

Trait Implementations

impl Debug for AuditSink

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

Formats the value using the given formatter.

impl Default for AuditSink

fn default() -> AuditSink

Returns the “default value” for a type.