Struct futures_bounded::FuturesMap

pub struct FuturesMap<ID, O> { /* private fields */ }

Represents a map of Futures.

Each future must finish within the specified time and the map never outgrows its capacity.

Implementations

impl<ID, O> FuturesMap<ID, O>

pub fn new(timeout: Duration, capacity: usize) -> Self

impl<ID, O> FuturesMap<ID, O>

where ID: Clone + Hash + Eq + Send + Unpin + 'static, O: 'static,

pub fn try_push<F>( &mut self, future_id: ID, future: F ) -> Result<(), PushError<BoxFuture<'_, O>>>

where F: Future<Output = O> + Send + 'static,

Push a future into the map.

This method inserts the given future with defined future_id to the set. If the length of the map is equal to the capacity, this method returns PushError::BeyondCapacity, that contains the passed future. In that case, the future is not inserted to the map. If a future with the given future_id already exists, then the old future will be replaced by a new one. In that case, the returned error PushError::Replaced contains the old future.

pub fn remove(&mut self, id: ID) -> Option<BoxFuture<'static, O>>

pub fn contains(&self, id: ID) -> bool

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn poll_ready_unpin(&mut self, cx: &mut Context<'_>) -> Poll<()>

pub fn poll_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<(ID, Result<O, Timeout>)>