Struct narwhal_types::bounded_future_queue::BoundedFuturesUnordered

pub struct BoundedFuturesUnordered<T: Future> { /* private fields */ }

An async-friendly FuturesUnordered of bounded size. In contrast to a bounded channel, the queue makes it possible to modify and remove entries in it. In contrast to a FuturesUnordered, the queue makes it possible to enforce a bound on the number of items in the queue.

Implementations

impl<T: Future> BoundedFuturesUnordered<T>

pub fn with_capacity(capacity: usize) -> Self

pub async fn push(&self, item: T)

Push an item into the queue. If the queue is currently full this method blocks until an item is available

pub fn push_with_permit(&self, item: T, _permit: SemaphorePermit<'_>)

pub async fn reserve(&self) -> Result<UnorderedPermit<'_, T>, AcquireError>

Waits for queue capacity. Once capacity to push one future is available, it is reserved for the caller.

WARNING: the order of pushing to the queue is not guaranteed. It must be enforced by the caller.

pub fn available_permits(&self) -> usize

Report the available permits

pub fn len(&self) -> usize

Report the length of the queue

pub fn is_empty(&self) -> bool

Report if the queue is empty

impl<U, V, T: Future<Output = Result<U, V>>> BoundedFuturesUnordered<T>

pub fn try_next(&mut self) -> impl Future<Output = Result<Option<U>, V>> + '_

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead.

Trait Implementations

impl<T: Future> Debug for BoundedFuturesUnordered<T>

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

Formats the value using the given formatter.

impl<T: Future> Send for BoundedFuturesUnordered<T>

impl<T: Future> Sync for BoundedFuturesUnordered<T>