Skip to main content

AuditRecord

Struct AuditRecord 

Source
#[non_exhaustive]
pub struct AuditRecord { pub id: AuditRecordId, pub schema_version: u16, pub actor_json: Value, pub operation: String, pub target_ref: String, pub created_at: DateTime<Utc>, pub outcome: Outcome, pub correlation_id: Option<CorrelationId>, }
Expand description

Doctrine-compliant audit record.

Required fields are positional in AuditRecord::new. There is no Default and no public field-init shorthand outside this module’s tests. See module docs for the full doctrine and anti-criterion.

Field order matches the audit_records columns in BUILD_SPEC §10 where they overlap; doctrine-only fields (outcome, correlation_id) are added at the end so the wire shape is forward-compatible with the §10 table.

Fields (Non-exhaustive)§

This struct is marked as 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.
§id: AuditRecordId

Stable identifier.

§schema_version: u16

Schema version this row was written under.

§actor_json: Value

Free-form actor descriptor (e.g. {"kind": "operator", "username": "alice"}). Opaque at this layer; see module-level anti-criterion.

§operation: String

Stable operation identifier (e.g. principle.promote, memory.accept).

§target_ref: String

Free-form reference to the target of the operation (typically a prefix-ULID ID, but any stable string is allowed).

§created_at: DateTime<Utc>

When the audit row was created, in UTC.

§outcome: Outcome

Outcome of the operation.

§correlation_id: Option<CorrelationId>

Optional cross-trace correlation identifier.

Implementations§

Source§

impl AuditRecord

Source

pub fn new( actor_json: Value, operation: String, target_ref: String, created_at: DateTime<Utc>, outcome: Outcome, ) -> Self

Construct a new audit record.

All doctrine-required fields are positional and required. This is the only public constructor: there is no Default::default() and no builder. Forgetting any required field is a compile error, not a runtime validation failure.

id is generated fresh; schema_version is set to crate::SCHEMA_VERSION.

Source

pub fn with_correlation(self, correlation_id: CorrelationId) -> Self

Attach an optional correlation id (chainable).

Trait Implementations§

Source§

impl Clone for AuditRecord

Source§

fn clone(&self) -> AuditRecord

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 AuditRecord

Source§

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

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

impl<'de> Deserialize<'de> for AuditRecord

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 JsonSchema for AuditRecord

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for AuditRecord

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for AuditRecord

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 Eq for AuditRecord

Source§

impl StructuralPartialEq for AuditRecord

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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