Struct AuditEvent 

#[non_exhaustive]
pub struct AuditEvent {
    pub ts: SystemTime,
    pub event: &'static str,
    pub url_scheme: String,
    pub dst_scheme: Option<String>,
    pub outcome: &'static str,
    pub error_kind: Option<&'static str>,
}

A redacted audit event.

Constructed via AuditEvent::start or AuditEvent::done; the struct is #[non_exhaustive] so external crates cannot widen the field set by struct-literal initialization. Sink implementations receive &AuditEvent and can serialize whichever fields they expose — but every field is, by construction, value-free.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ts: SystemTime

event: &'static str

url_scheme: String

dst_scheme: Option<String>

outcome: &'static str

error_kind: Option<&'static str>

Implementations

impl AuditEvent

pub fn start(verb: Verb, scheme: impl Into<String>) -> Self

Build a *.start event for verb operating on a URL with scheme. Default outcome is "started".

pub fn done( verb: Verb, scheme: impl Into<String>, outcome: &'static str, ) -> Self

Build a *.done event for verb with the given outcome label.

pub fn with_dst_scheme(self, dst_scheme: impl Into<String>) -> Self

Attach a destination scheme (used by cp, diff, and any future two-URL verb).

pub fn with_error_kind(self, kind: &'static str) -> Self

Attach a stable error-kind classifier (from Error::kind()).

pub fn with_event( event: &'static str, scheme: impl Into<String>, outcome: &'static str, ) -> Self

Build an event with an arbitrary 'static event label.

CLI-only verbs that do not belong on the library-side Verb enum (e.g., run.start / run.done from subprocess env injection) build events through this constructor. The &'static str bound prevents runtime-built label strings from smuggling value bytes into the audit envelope: callers must pass string literals known at compile time.

pub fn cache(kind: CacheEvent, scheme: impl Into<String>) -> Self

Build a cache event for the given URL scheme. Single-phase — the outcome field carries the same classifier as event (e.g., event = "cache.hit", outcome = "hit") so consumers that filter on outcome see a stable label without parsing the event prefix.

pub fn to_json_line(&self) -> String

Render to a single-line JSON string with no trailing newline.

Wire format (fields appear in this order):

{"event":"get.done","ts":1234567890,"src_scheme":"vault","outcome":"ok"}

dst_scheme and error_kind appear only when populated. The timestamp is UNIX seconds since the epoch; clock-skew anomalies fall back to 0 rather than panicking on the secret path.

Trait Implementations

impl Clone for AuditEvent

fn clone(&self) -> AuditEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditEvent

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

Formats the value using the given formatter.