Struct PurgeQueue 

pub struct PurgeQueue(/* private fields */);

The queue: one worker, one purge at a time, FIFO, deduplicated by account.

A named type over JobQueue<Purge> rather than an alias, so Accounts.Purge’s door keeps taking a PurgeOrder and taking its job id out first, which is the shape the gate demands.

Implementations

impl PurgeQueue

pub fn new(run: PurgeRunner, release: GateRelease) -> Self

A queue over run, releasing gates through release. No thread is started until something is enqueued.

pub fn next_job_id(&self) -> String

The job id the NEXT enqueue would use, without enqueuing.

The gate has to be taken before the job exists — that is what makes the lockout a fact by the time Accounts.Purge returns — and the gate’s holder has to be the job id, or the release could not tell this job’s lockout from anybody else’s. So the id is minted here, handed to the gate, and handed back in on PurgeQueue::enqueue inside the order.

Minting from the same counter as enqueue, so an id handed out here and never used simply leaves a gap. A gap in a job-id sequence costs nothing; two jobs sharing an id would make the release ambiguous.

pub fn enqueue(&self, order: PurgeOrder) -> PurgeJob

Ask for an account to be emptied.

Returns the job now responsible for the account: a new one, or the one that was already queued or running — in which case this order’s job_id is not used, and the caller must not assume its gate is the one that will be released. Accounts.Purge handles that by reading the gate back out of the table rather than trusting the one it wrote.

pub fn status(&self, account: &str) -> Option<PurgeJob>

The job the queue is holding for account, if it still has one.

pub fn peak_in_flight(&self) -> usize

The highest number of purges that have ever run together. Must be 1.

pub fn runs(&self) -> u64

How many times the runner has been called.

pub fn stop(&self)

Stop the worker after the job it is on.

Trait Implementations

impl Clone for PurgeQueue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.