Struct JobRegistry 

pub struct JobRegistry {
    next_id: AtomicU64,
    jobs: Mutex<BTreeMap<u64, JobRecord>>,
    updates: Sender<JobStatus>,
}

State of the jobs of a session.

Fields

next_id: AtomicU64

ID of the next job.

jobs: Mutex<BTreeMap<u64, JobRecord>>

State of each job, by ID.

updates: Sender<JobStatus>

Channel every job change is sent to.

Implementations

impl JobRegistry

pub fn has_unfinished_jobs(&self) -> bool

Returns if any job is queued or running.

pub fn create(&self, method: &str) -> u64

Registers a new queued job.

Returns

The ID of the job.

pub fn start(&self, job: u64) -> bool

Marks a queued job as running.

Returns

false if the job was cancelled or is unknown, so it must not run.

pub fn set_stage(&self, job: u64, stage: &str)

Sets the step a running job is on.

pub fn set_progress(&self, job: u64, progress: u8)

Sets how far along a running job is, from 0 to 100.

Only increases are kept, as parallel steps of a job may report their progress out of order.

pub fn requeue(&self, job: u64) -> bool

Moves a running job back to the queue.

Returns

false if the job isn’t running.

pub fn finish_cancelled(&self, job: u64)

Ends a job as cancelled, even if it already started.

pub fn finish(&self, job: u64, outcome: RpcOutcome)

Ends a job with the outcome of its method.

pub fn cancel(&self, job: u64) -> Result<JobStatus, ApiError>

Cancels a job that hasn’t started yet.

Errors

Fails if the job is unknown, or if it already started.

pub fn status(&self, job: u64) -> Option<JobStatus>

Returns the state of a job, or None if it’s unknown.

pub fn record(&self, job: u64) -> Option<JobRecord>

Returns the state of a job with when it was created and last changed, or None if it’s unknown.

pub fn subscribe(&self) -> Receiver<JobStatus>

Returns a receiver of every job change from now on.

pub async fn wait(&self, job: u64, timeout: Duration) -> Option<JobStatus>

Waits for a job to end, up to timeout.

Returns

The state of the job when it ended, or when the wait timed out. None if the job is unknown.

fn transition( &self, job: u64, change: impl FnOnce(&JobState) -> Option<JobState>, ) -> Option<JobStatus>

Changes the state of a job with change, which returns the new state, or None to keep the current one.

Returns

The new state of the job, or None if it’s unknown or didn’t change.

fn set(&self, status: JobStatus)

Stores the state of a job, forgetting the oldest ended jobs over MAX_ENDED_JOBS, and notifies it.

fn notify(&self, status: JobStatus)

Sends a job change to the listeners, if there are any.

Trait Implementations

impl Debug for JobRegistry

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

Formats the value using the given formatter.

impl Default for JobRegistry

fn default() -> Self

Returns the “default value” for a type.