Struct Reporter 

pub struct Reporter<K: JobKind> { /* private fields */ }

The handle a running job reports through.

Every method takes &self and writes into the job under the queue’s lock, so a console polling a status RPC sees a count that moves rather than a job that sits at zero for four minutes and then jumps.

Implementations

impl<K: JobKind> Reporter<K>

pub fn key(&self) -> &str

The subject this job is working on, for a runner that wants it back.

pub fn progress(&self, done: u64, total: u64)

How far along, in whatever the kind counts. Overwrites the previous reading; a progress that accumulated across reports would be a second counter to keep right.

pub fn report(&self, apply: impl FnOnce(&mut K::Report))

Write into the kind’s own report.

pub fn snapshot(&self) -> Option<Job<K>>

The job as it stands right now, for a runner that has to read back what it reported.

The one caller is the mirror runner, which publishes an event-stream event carrying the reference list it wrote through Reporter::report. That list is on the JOB — it has to be, because a status RPC renders it — and a runner that also kept its own copy would be two places the same facts could disagree (one implementation).

None when the job is gone, which nothing does while a runner is running: a live job is never pruned.

impl Reporter<Purge>

pub fn found(&self, stores: u32)

How many stores the walk found. Called once, when the walk has finished counting and before it starts unlinking.

pub fn reclaimed(&self, bytes: u64)

One store is gone, and this is what it was holding.

pub fn failed(&self, note: String)

One store could NOT be reclaimed, and this is why.

Recorded and the walk continues. Stopping at the first failure would leave the rest of an account that is being closed on the disk because one directory had bad permissions — and the operator would have to run the purge again anyway.

pub fn principal_removed(&self)

The principal itself was removed.

pub fn account(&self) -> &str

The account this purge is emptying, for a runner that wants it back.

Trait Implementations

impl<K: JobKind> Clone for Reporter<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.