Skip to main content

Pool

Struct Pool 

Source
pub struct Pool<I, O>
where I: Send + 'static, O: Send + Clone + 'static,
{ /* private fields */ }
Expand description

A bounded async worker pool.

Implementations§

Source§

impl<I, O> Pool<I, O>
where I: Send + 'static, O: Send + Clone + 'static,

Source

pub fn new(handler: Arc<dyn Handler<I, O>>, config: PoolConfig) -> Self

Create a new pool backed by handler.

config.size is clamped to a minimum of 1 (a zero-sized pool can never execute tasks because no permits would be available); a tracing warn is emitted when this clamp engages.

Source

pub async fn submit(&self, input: I) -> AppResult<TaskHandle<O>>

Submit a task; returns a TaskHandle immediately.

Source

pub fn stats(&self) -> PoolStats

Snapshot of pool activity.

Source

pub fn available_permits(&self) -> usize

Number of permits currently available for task execution.

Source

pub fn close(&self)

Stop accepting work and ask the runner loop to exit.

Source

pub async fn shutdown(self) -> AppResult<()>

Cancel all in-flight tasks and shut down the runner loop.

Trait Implementations§

Source§

impl<I, O> Drop for Pool<I, O>
where I: Send + 'static, O: Send + Clone + 'static,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

§

impl<I, O> !RefUnwindSafe for Pool<I, O>

§

impl<I, O> !UnwindSafe for Pool<I, O>

§

impl<I, O> Freeze for Pool<I, O>

§

impl<I, O> Send for Pool<I, O>

§

impl<I, O> Sync for Pool<I, O>

§

impl<I, O> Unpin for Pool<I, O>

§

impl<I, O> UnsafeUnpin for Pool<I, O>

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