Struct PurgeOrder 

pub struct PurgeOrder {
    pub account: String,
    pub job_id: String,
    pub principal_id: String,
    pub reason: String,
    pub remove_principal: bool,
    pub expect_empty: bool,
}

What a purge was asked for, carried on the job so the worker can hand it back to the runner minutes later.

The queue holds the whole order rather than the account name alone because remove_principal and expect_empty change what a purge is, and a queue that kept them in a side map keyed by account would be a second place the two could disagree — with the more destructive reading winning whenever they did.

Fields

account: String

The account: a principal id, which is also its namespace.

job_id: String

The job id, minted before the gate was taken, because the gate’s holder has to be this job or the release could not tell this lockout from anybody else’s. See PurgeQueue::next_job_id.

principal_id: String

The principal that asked, for the audit trail.

reason: String

Why, shown to the locked-out user and written into every reclaim’s log line.

remove_principal: bool

Also remove the principal, its keys, grants, tokens and memberships.

expect_empty: bool

Refuse rather than destroy unless the account holds no live repositories.

Implementations

impl PurgeOrder

pub fn new( account: impl Into<String>, job_id: impl Into<String>, reason: impl Into<String>, ) -> Self

The ordinary order: empty the account, keep the principal.

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

Record who asked.

pub fn removing_principal(self, remove: bool) -> Self

Take the principal with the data.

pub fn expecting_empty(self, expect: bool) -> Self

Refuse rather than destroy if anything is still live.

Trait Implementations

impl Clone for PurgeOrder

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 PurgeOrder

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

Formats the value using the given formatter.