Skip to main content

Worker

Struct Worker 

Source
pub struct Worker { /* private fields */ }
Expand description

Pulls jobs off a queue and runs them.

Implementations§

Source§

impl Worker

Source

pub fn with_locks(self, locks: LockManager) -> Self

Enforce unique_id releases with locks.

The same manager the dispatching side uses, or the release will not find the key. Worker::from_manager wires it for you.

Source

pub fn new( queue: Arc<dyn Queue>, registry: Arc<JobRegistry>, container: Arc<Container>, ) -> Self

A worker serving queue, running the jobs registry knows.

Source

pub fn with_events(self, events: Arc<Dispatcher>) -> Self

Fire lifecycle events through events.

Source

pub fn with_options(self, options: WorkerOptions) -> Self

Configure the loop.

Source

pub fn stop(&self)

Ask the loop to stop after the job in flight.

Source

pub fn is_stopping(&self) -> bool

Whether a stop has been requested.

Source

pub async fn run_next(&self) -> Result<Outcome>

Reserve and run one job from the first queue that has one.

Source

pub async fn run(&self) -> Result<WorkerStats>

Run until stopped, drained, or the job limit is reached.

Between jobs the worker flushes the container’s scoped bindings, so one job cannot leak per-request-shaped state into the next. That is the long-running-process hazard a per-request framework never has to think about.

Trait Implementations§

Source§

impl Debug for Worker

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !Freeze for Worker

§

impl !RefUnwindSafe for Worker

§

impl !UnwindSafe for Worker

§

impl Send for Worker

§

impl Sync for Worker

§

impl Unpin for Worker

§

impl UnsafeUnpin for Worker

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

fn event_name() -> &'static str
where Self: Sized,

A human-readable name, used by wildcard listeners and log output. Always the Rust type path; see the trait docs.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more