Struct AccountGate 

pub struct AccountGate {
    pub account: String,
    pub reason: GateReason,
    pub holder: String,
    pub actor: String,
    pub note: String,
    pub at: UnixMillis,
    pub expires: Option<UnixMillis>,
}

One account, locked.

Keyed in the identity table by AccountGate::account, which is a principal id — and therefore also the namespace that principal intrinsically owns (crate::AuthTable::owns_account). One row covers both senses of “this user is locked out” because in gunnar they are the same name.

Fields

account: String

The principal id, which is also the account namespace.

reason: GateReason

Why it is gated: somebody decided (GateReason::Administrative, no deadline) or a purge holds it (GateReason::Purge, with expires).

holder: String

Who set it: a principal id for an operator, a job id for a purge. Read back by crate::AuthTable::lift_gate_held_by, which is what stops a finishing purge from lifting somebody else’s suspension.

actor: String

The principal that asked, for the audit trail. A purge records the principal that called Accounts.Purge, not the worker thread.

note: String

Free text, shown to the locked-out user. Not optional in practice: a refusal with no reason is a support ticket.

at: UnixMillis

When it was set.

expires: Option<UnixMillis>

None for an administrative gate — it never expires on its own. Some for a purge lease; see PURGE_LEASE_MS.

Implementations

impl AccountGate

pub fn administrative( account: impl Into<String>, actor: impl Into<String>, note: impl Into<String>, ) -> Self

A gate a person or a service set, with no deadline.

pub fn purge_lease( account: impl Into<String>, job_id: impl Into<String>, expires: UnixMillis, ) -> Self

A purge’s lease, expiring at expires.

Takes the deadline rather than computing now + PURGE_LEASE_MS so a test can hand it a time in the past and see the expiry rule fire, which is the only way to observe the property that keeps an account from being bricked by a crash.

pub fn by(self, actor: impl Into<String>) -> Self

Record the principal that asked for the purge, for the audit trail.

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

Replace the note shown to the locked-out user.

pub fn is_live_at(&self, now: UnixMillis) -> bool

Is this gate in force at now?

The one place the deadline is read, so an expired lease cannot be in force for the ACL and absent from the listing, or the other way round (one implementation).

pub fn is_live(&self) -> bool

AccountGate::is_live_at against the wall clock.

Trait Implementations

impl Clone for AccountGate

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 AccountGate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AccountGate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AccountGate

impl PartialEq for AccountGate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AccountGate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AccountGate