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<S>(name: &str) -> Self

Create a new worker context

pub fn name(&self) -> &String

Get the worker id

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

Start running the worker

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

Restart running the worker

pub fn track<F: Future>(&self, task: F) -> Tracked<F>

Start a task that is tracked by 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

Returns if the worker is ready to consume new tasks

pub fn get_service(&self) -> &str

Get the type of service

pub fn is_running(&self) -> bool

Returns whether the worker is running

pub fn is_pending(&self) -> bool

Returns whether the worker is pending

pub fn is_paused(&self) -> bool

Returns whether the worker is paused

pub fn task_count(&self) -> usize

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

pub fn has_pending_tasks(&self) -> bool

Returns whether the worker has pending tasks

pub fn is_shutting_down(&self) -> bool

Is the shutdown token called

pub fn emit(&mut self, event: &Event)

Allows workers to emit events

pub fn wrap_listener<F: Fn(&WorkerContext, &Event) + Send + Sync + 'static>( &mut self, f: F, )

Wraps the event listener with a new function

Trait Implementations

impl Clone for WorkerContext

fn clone(&self) -> WorkerContext

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.

impl<Args: Sync, Ctx: Sync, IdType: Sync + Send> FromRequest<Task<Args, Ctx, IdType>> for WorkerContext

type Error = MissingDataError

The error type that can occur during extraction.

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

Perform the extraction.

impl Future for WorkerContext

type Output = Result<(), WorkerError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.