Skip to main content

AuditMetadata

Struct AuditMetadata 

Source
pub struct AuditMetadata {
    pub actor_id: String,
    pub actor_session_id: Option<String>,
    pub source_ip: Option<String>,
    pub user_agent: Option<String>,
    pub timestamp_utc_us: i64,
    pub causation_id: Option<Uuid>,
    pub correlation_id: Uuid,
}
Expand description

Audit fields stamped on every persisted event.

See module docs for the lifecycle and reserved actor identifiers.

Fields§

§actor_id: String

Required. Aggregate UUID, "system", "anonymous", or "legacy-pre-hipaa". Must be non-empty after trim.

§actor_session_id: Option<String>

Optional. The session this command was dispatched in. Pair with HIPAA-4 server-side session store for revocation.

§source_ip: Option<String>

Optional. Source IP. None for system-internal commands.

§user_agent: Option<String>

Optional. User-Agent header.

§timestamp_utc_us: i64

Required. Microseconds since UNIX epoch. Must be > 0.

§causation_id: Option<Uuid>

Optional. Event ID that triggered the command that produced this event (saga / projection-driven follow-up).

§correlation_id: Uuid

Required. Groups every event from one logical request together. CommandContext::system synthesizes one for internal jobs.

Implementations§

Source§

impl AuditMetadata

Source

pub fn new( actor_id: impl Into<String>, correlation_id: Uuid, ) -> Result<Self, AuditError>

Construct a new validated AuditMetadata from raw inputs.

timestamp_utc_us is set from the system clock. Use [AuditMetadata::with_timestamp] to supply an explicit value (testing, replay, deterministic builds).

Source

pub fn system() -> Self

Convenience constructor for system-internal jobs (cron, seeders, migrations). Synthesizes a correlation_id. Always passes validation.

Source

pub fn pending() -> Self

Placeholder value used by Event::new. The CommandBus overwrites this with a real value from the request CommandContext before append. Calling validate() on a pending value returns AuditError::PendingNotStamped — the store rejects the write.

Source

pub fn is_pending(&self) -> bool

True when audit == pending(). Stores reject pending audits at append-time.

Source

pub fn validate(&self) -> Result<(), AuditError>

Defense-in-depth validation. Stores call this at the top of append.

Trait Implementations§

Source§

impl Clone for AuditMetadata

Source§

fn clone(&self) -> AuditMetadata

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AuditMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AuditMetadata

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AuditMetadata

Source§

fn eq(&self, other: &AuditMetadata) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for AuditMetadata

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AuditMetadata

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more