Struct AuditEvent 

pub struct AuditEvent { /* private fields */ }

The app’s own event for the audit log of a panel with Panel::audit_log: a sign-in, an export, a payment, beside what the panel’s writes record.

AuditEvent::new("export")
    .resource("orders")
    .record(cx, ex)
    .await?;

Implementations

impl AuditEvent

pub fn new(event: impl Into<String>) -> Self

An event named event, on no resource: the log shows the name as it is.

pub fn resource(self, slug: impl Into<String>) -> Self

The slug of the resource it happened to: only readers who may list that resource see it.

pub fn key(self, key: impl Into<String>, url: Option<String>) -> Self

The key of the record it happened to, and its page when it has one.

pub fn change( self, field: impl Into<String>, label: impl Into<String>, before: Option<String>, after: Option<String>, ) -> Self

A field it changed, from before to after.

impl AuditEvent

pub async fn record(self, cx: &Cx, ex: &mut dyn Executor) -> Result<AuditEntry>

Stores the event for the request’s panel, user and tenant through ex: the write’s transaction inside a CommitHook or Resource::before_commit, or the panel’s Db outside one.

Errors

A declaration error outside every panel; an opaque infrastructure failure when the row cannot be written, the driver’s text going to the log.

Trait Implementations

impl Clone for AuditEvent

fn clone(&self) -> Self

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.