Skip to main content

WorkerPool

Struct WorkerPool 

Source
pub struct WorkerPool<T: Send + 'static, R: Send + 'static> { /* private fields */ }
Expand description

A dynamically-scaling pool of Tokio worker tasks.

Generic over:

  • T — the input type passed to each work item (must be Send + 'static)
  • R — the result type returned by the handler (must be Send + 'static)

Implementations§

Source§

impl<T: Send + 'static, R: Send + 'static> WorkerPool<T, R>

Source

pub fn new( config: WorkerConfig, handler: Arc<dyn Fn(T) -> BoxFuture<'static, R> + Send + Sync>, ) -> Self

Create a new pool with the given configuration and async handler function.

min_workers worker tasks are spawned immediately.

Source

pub async fn submit(&self, item: T, priority: u8) -> Receiver<R>

Submit a work item with the given priority (higher = more urgent).

Returns a [oneshot::Receiver<R>] that resolves when processing is done. If the queue is full (bounded channel) this will apply back-pressure and await until space is available.

Source

pub fn scale_up(&self)

Spawn one additional worker task.

Source

pub fn scale_down(&self)

Signal one idle worker above min_workers to exit on its next idle timeout.

This is a best-effort hint; the worker may be processing an item and will only exit after completing it and then timing out.

Source

pub async fn drain_and_shutdown(&self)

Wait for the queue to drain completely, then stop all workers.

After this method returns the pool must not be used again.

Source

pub fn stats(&self) -> PoolStats

Return a point-in-time snapshot of pool statistics.

Auto Trait Implementations§

§

impl<T, R> !RefUnwindSafe for WorkerPool<T, R>

§

impl<T, R> !UnwindSafe for WorkerPool<T, R>

§

impl<T, R> Freeze for WorkerPool<T, R>

§

impl<T, R> Send for WorkerPool<T, R>

§

impl<T, R> Sync for WorkerPool<T, R>

§

impl<T, R> Unpin for WorkerPool<T, R>

§

impl<T, R> UnsafeUnpin for WorkerPool<T, R>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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