Struct WorkerContext 

pub struct WorkerContext { /* private fields */ }

Utility for managing a worker’s context

A worker context is created for each worker thread and is responsible for managing the worker’s state, task tracking, and event handling.

Tip: All fields are wrapped inside Arc so it should be cheap to clone

Implementations

impl WorkerContext

pub fn new(name: &str) -> Self

Create a new worker context

pub fn name(&self) -> &str

Get the worker id

pub fn start(&mut self) -> Result<(), WorkerError>

Start running the worker

pub fn pause(&self) -> Result<(), WorkerError>

Pauses a worker, preventing any new jobs from being polled

pub fn resume(&self) -> Result<(), WorkerError>

Resume a worker that is paused

pub fn stop(&self) -> Result<(), WorkerError>

Calling this function triggers shutting down the worker while waiting for any tasks to complete

pub fn is_ready(&self) -> bool

Checks if the worker is ready to consume new tasks

pub fn get_service(&self) -> &str

Get the type_name of the service used

Example

async fn send_email(email: Email) {}

// Might be something like:
TaskFn<send_email, Email, ()>>

pub fn is_running(&self) -> bool

Checks whether the worker is running

pub fn is_pending(&self) -> bool

Checks whether the worker is pending

pub fn is_paused(&self) -> bool

Checks whether the worker is paused

pub fn is_stopped(&self) -> bool

Checks whether the worker has been stopped

pub fn is_terminated(&self) -> bool

Checks whether the worker is terminated

pub fn task_count(&self) -> usize

Checks the current futures in the worker domain This include futures spawned via worker.track

pub fn has_pending_tasks(&self) -> bool

Checks whether the worker has pending tasks

pub fn is_shutting_down(&self) -> bool

Is the shutdown token called

pub fn state(&self) -> &str

Get the current worker state

pub fn emit<T: Send + Sync + 'static>(&self, data: T)

Emits a Event::Custom to the worker’s event handler

pub fn heartbeat(&self, cx: &mut Context<'_>)

Calls a method to signify a heartbeat with the worker

pub fn cancel_task(&self, context: &TaskContext) -> Result<(), TaskStateError>

Available on crate feature task-context only.

Cancel a specific task, if it’s tracked.

pub fn get_task(&self, task_id: &str) -> Result<TaskContext, TaskStateError>

Available on crate feature task-context only.

Get the task context for a task attached to a worker

pub fn cleanup(&self) -> Result<(), TaskStateError>

Available on crate feature task-context only.

Remove any completed tasks

pub fn tasks(&self) -> Result<Vec<TaskContext>, TaskStateError>

Available on crate feature task-context only.

Get the context of each running task

pub fn elapsed(&self) -> Duration

Returns the amount of time elapsed since this worker started.

pub fn restarts(&self) -> usize

Returns the number of times the worker has been restated:

See also Monitor::should_restart

pub fn kill(&mut self) -> Result<(), WorkerError>

This forces a shutting down worker to exit.

Trait Implementations

impl Clone for WorkerContext

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 WorkerContext

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

Formats the value using the given formatter.

impl Drop for WorkerContext

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<&WorkerContext> for WorkerContext

fn from(context: &Self) -> Self

Converts to this type from the input type.

impl From<&str> for WorkerContext

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<String> for WorkerContext

fn from(name: String) -> Self

Converts to this type from the input type.

impl<Args: Sync> FromRequest<Task<Args>> for WorkerContext

type Error = MissingDataError

The error type that can occur during extraction.

async fn from_request(task: &Task<Args>) -> Result<Self, Self::Error>

Perform the extraction.