Skip to main content

AuditEntry

Struct AuditEntry 

Source
pub struct AuditEntry { /* private fields */ }
Expand description

A single auditable event.

Audit entries are append-only. They are persisted in the AuditSink and may be displayed by the TUI.

§Examples

use evault_core::model::{AuditAction, AuditEntry, VarId};
let entry = AuditEntry::for_var(VarId::new_v4(), AuditAction::Created);
assert_eq!(entry.action(), &AuditAction::Created);

Implementations§

Source§

impl AuditEntry

Source

pub fn for_var(var_id: VarId, action: AuditAction) -> Self

Create a new audit entry referencing a single variable.

Source

pub fn for_project( project_id: ProjectId, var_id: Option<VarId>, action: AuditAction, ) -> Self

Create a new audit entry referencing a project (and optionally a var).

Source

pub fn with_note(self, note: impl Into<String>) -> Self

Attach a free-form note (e.g. the command that was executed).

Source

pub const fn from_parts( id: AuditId, action: AuditAction, var_id: Option<VarId>, project_id: Option<ProjectId>, note: Option<String>, at: OffsetDateTime, ) -> Self

Rehydrate an AuditEntry from already-stored fields.

Source

pub const fn id(&self) -> AuditId

Returns the entry’s stable identifier.

Source

pub const fn action(&self) -> &AuditAction

Returns the action recorded by this entry.

Source

pub const fn var_id(&self) -> Option<VarId>

Returns the referenced variable, if any.

Source

pub const fn project_id(&self) -> Option<ProjectId>

Returns the referenced project, if any.

Source

pub fn note(&self) -> Option<&str>

Returns the free-form note, if any.

Source

pub const fn at(&self) -> OffsetDateTime

Returns the timestamp the entry was recorded (UTC).

Trait Implementations§

Source§

impl Clone for AuditEntry

Source§

fn clone(&self) -> AuditEntry

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 AuditEntry

Source§

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

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

impl<'de> Deserialize<'de> for AuditEntry

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 AuditEntry

Source§

fn eq(&self, other: &AuditEntry) -> 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 AuditEntry

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 AuditEntry

Source§

impl StructuralPartialEq for AuditEntry

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> 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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,