Struct Purge 

pub struct Purge { /* private fields */ }

The purge kind. What a purge is, and — the part a gc has no equivalent of — what a purge has to give back when it ends, however it ends.

Trait Implementations

impl JobKind for Purge

fn key(order: &PurgeOrder) -> &str

Keyed by ACCOUNT, because both questions the queue answers are per account: “is one already running for this account” on enqueue, and “how is mine going” on status.

fn settle( &self, order: &PurgeOrder, outcome: Result<(), String>, progress: &Progress, ) -> (JobState, Option<String>)

The release, on every path.

Unconditional, and the runner reaches it after a success, after a failure and after a panic — that is what JobKind::settle is for and it is the whole reason the release is the queue’s job and not the runner’s: a runner that returned early, failed, or blew up would each be a different missed unlock, and “release it in the runner’s error path too” is a rule that holds until the next early return somebody adds.

fn shutdown_error(&self) -> String

Reported with gate_released: false on purpose: the caller has already taken a lockout under this id and has to know that nothing is going to take it off.

fn spawn_error(&self, err: &dyn Display) -> String

No worker means the job will never run — and the account is already locked. Say both, on the job, rather than leave it QUEUED for ever.

const NAME: &'static str = "purge"

The kind’s short name. It is the job-id prefix (gc-7, purge-12, mirror-3), the jera lane’s job kind (gc), and the noun in every message this module writes — so an operator reading a stack dump or a FAILED job knows what it was without a lookup.

type Order = PurgeOrder

What was asked for, carried on the job so the worker can hand it back to JobKind::run minutes later.

type Report = PurgeReport

What the job produced, in the kind’s own words: a gc’s bytes, a purge’s stores and gate, a mirror’s objects.

fn run(&self, order: &PurgeOrder, progress: &Progress) -> Result<(), String>

Do the work. Runs on the lane’s blocking thread, outside the queue’s lock, inside a std::panic::catch_unwind.

const FINISHED_RETENTION: Duration = DEFAULT_FINISHED_RETENTION

How long a finished job of this kind stays readable.

const FINISHED_KEPT: usize = DEFAULT_FINISHED_KEPT

Finished jobs of this kind kept regardless of age.