Struct Worker

pub struct Worker<S, R = NoopWorkerRegistry> { /* private fields */ }

A worker where workers can be registered and are executed whenever tasks are ready.

Implementations

impl<S> Worker<S>

where S: WorkerStore + 'static,

pub fn new(store: S) -> Self

Create a new worker with the default options.

pub fn new_with_options(store: S, options: WorkerOptions) -> Self

Create a new worker.

impl<S, R> Worker<S, R>

pub fn register_handler( &mut self, worker: Arc<dyn RawHandler + Send + Sync>, ) -> &mut Self

Register a handler for the worker.

Panics

Panics if a handler was already registered with a matching WorkerSelector.

pub fn with_registry<R2>(self, registry: R2) -> Worker<S, R2>

Set the registry for this worker.

pub fn with_name(self, name: impl Into<String>) -> Self

Set the name of this worker.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description of this worker.

pub fn with_version(self, version: impl Into<String>) -> Self

Set the version of this worker.

pub fn handle(&self) -> WorkerHandle

Get a handle to this worker.

pub fn handlers(&self) -> impl Iterator<Item = &WorkerSelector>

Get the worker selectors for the handlers registered with this worker.

pub fn handler_count(&self) -> usize

Return the count of handlers registered.

pub fn metadata(&self) -> &WorkerMetadata

Get the metadata for this worker.

impl<S, R> Worker<S, R>

where S: WorkerStore + 'static, R: WorkerRegistry,

pub async fn run(self) -> Result<(), Error>

Run the worker indefinitely.

Errors

The function returns on any store error.

Panics

Only panics due to bugs.

Trait Implementations

impl<S: Debug> Debug for Worker<S>

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

Formats the value using the given formatter.