Struct AuditInfo 

pub struct AuditInfo {
    pub created_at: Timestamp,
    pub updated_at: Timestamp,
    pub created_by: Principal,
    pub updated_by: Principal,
}

Audit metadata embedded in API resource structs.

Tracks creation and last-update times (RFC 3339) and the Principal that performed each action. Both actor fields are non-optional — system processes are still actors and must declare themselves via Principal::system.

Example

use api_bones::{AuditInfo, Principal};

use uuid::Uuid;
let info = AuditInfo::now(Principal::human(Uuid::nil()));

Fields

created_at: Timestamp

When the resource was created (RFC 3339).

updated_at: Timestamp

When the resource was last updated (RFC 3339).

created_by: Principal

Identity of the actor who created the resource.

updated_by: Principal

Identity of the actor who last updated the resource.

Implementations

impl AuditInfo

pub fn new( created_at: Timestamp, updated_at: Timestamp, created_by: Principal, updated_by: Principal, ) -> Self

Construct an AuditInfo with explicit timestamps and principals.

Examples

use api_bones::{AuditInfo, Principal};
use chrono::Utc;
use uuid::Uuid;

let now = Utc::now();
let actor = Principal::human(Uuid::nil());
let info = AuditInfo::new(now, now, actor.clone(), actor);

pub fn now(created_by: Principal) -> Self

Construct an AuditInfo with created_at and updated_at set to the current UTC time. updated_by is initialized to a clone of created_by.

Requires the chrono feature.

Examples

use api_bones::{AuditInfo, Principal};

let actor = Principal::human(Uuid::nil());
let info = AuditInfo::now(actor.clone());
assert_eq!(info.created_by, actor);
assert_eq!(info.updated_by, actor);

pub fn touch(&mut self, updated_by: Principal)

Update updated_at to the current UTC time and set updated_by.

Requires the chrono feature.

Examples

use api_bones::{AuditInfo, Principal};

let mut info = AuditInfo::now(Principal::human(Uuid::nil()));
info.touch(Principal::system("billing.rotation-engine"));
assert_eq!(info.updated_by.as_str(), "billing.rotation-engine");

Trait Implementations

impl Clone for AuditInfo

fn clone(&self) -> AuditInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuditInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AuditInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for AuditInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AuditInfo

impl StructuralPartialEq for AuditInfo