Skip to main content

Pool

Struct Pool 

Source
pub struct Pool<'a, T> { /* private fields */ }
Expand description

An unordered pool of futures.

Futures can be added to the pool, and removed from the pool as they resolve.

Note: This pool is not thread-safe and should not be used across threads without external synchronization.

Implementations§

Source§

impl<'a, T: Send> Pool<'a, T>

Source

pub fn len(&self) -> usize

Returns the number of futures in the pool.

Source

pub fn is_empty(&self) -> bool

Returns true if the pool is empty.

Source

pub fn push(&mut self, future: impl Future<Output = T> + Send + 'a)

Adds a future to the pool.

The future must be Send and outlive 'a to ensure it can be safely stored and executed.

Source

pub fn next_completed( &mut self, ) -> SelectNextSome<'_, FuturesUnordered<Pin<Box<dyn Future<Output = T> + Send + 'a>>>>

Returns a futures that resolves to the next future in the pool that resolves.

If the pool is empty, the future will never resolve.

Source

pub fn cancel_all(&mut self)

Cancels all futures in the pool.

Excludes the dummy future.

Trait Implementations§

Source§

impl<'a, T: Send> Default for Pool<'a, T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a, T> !Freeze for Pool<'a, T>

§

impl<'a, T> !RefUnwindSafe for Pool<'a, T>

§

impl<'a, T> !Sync for Pool<'a, T>

§

impl<'a, T> !UnwindSafe for Pool<'a, T>

§

impl<'a, T> Send for Pool<'a, T>
where FuturesUnordered<Pin<Box<dyn Future<Output = T> + Send + 'a>>>: Send,

§

impl<'a, T> Unpin for Pool<'a, T>
where FuturesUnordered<Pin<Box<dyn Future<Output = T> + Send + 'a>>>: Unpin,

§

impl<'a, T> UnsafeUnpin for Pool<'a, T>
where FuturesUnordered<Pin<Box<dyn Future<Output = T> + Send + 'a>>>: UnsafeUnpin,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Threaded<T> for T

Source§

type Rest = ()

The outputs beyond the threaded value.
Source§

fn split(self) -> (T, ())

Splits into the threaded value and the extra outputs.
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