Skip to main content

DelayQueue

Struct DelayQueue 

Source
pub struct DelayQueue<T> { /* private fields */ }
Expand description

A queue of values that become available after their deadlines elapse.

The queue owns one operating-system timer and multiplexes all entries through a min-heap, so adding many timers does not consume one native timer handle per entry.

Implementations§

Source§

impl<T> DelayQueue<T>

Source

pub fn new() -> Result<Self>

Creates a new, empty queue.

Source

pub fn insert_at(&mut self, value: T, deadline: Instant) -> Key

Inserts value and returns a key that can remove it before expiration.

Source

pub fn try_insert(&mut self, value: T, timeout: Duration) -> Result<Key>

Tries to insert value to expire after timeout.

Source

pub fn insert(&mut self, value: T, timeout: Duration) -> Key

Inserts value to expire after timeout.

§Panics

Panics if the timeout exceeds the supported clock range.

Source

pub fn remove(&mut self, key: Key) -> Option<T>

Removes an entry if it has not expired.

Source

pub fn clear(&mut self)

Removes all entries and disarms the underlying timer.

Source

pub fn len(&self) -> usize

Returns the number of unexpired entries.

Source

pub fn is_empty(&self) -> bool

Returns true when the queue contains no unexpired entries.

Trait Implementations§

Source§

impl<T> Stream for DelayQueue<T>

Source§

type Item = Result<Expired<T>, Error>

Values yielded by the stream.
Source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more
Source§

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for DelayQueue<T>

§

impl<T> !UnwindSafe for DelayQueue<T>

§

impl<T> Freeze for DelayQueue<T>
where Slab<Slot<T>>: Freeze,

§

impl<T> Send for DelayQueue<T>
where Slab<Slot<T>>: Send,

§

impl<T> Sync for DelayQueue<T>
where Slab<Slot<T>>: Sync,

§

impl<T> Unpin for DelayQueue<T>
where Slab<Slot<T>>: Unpin,

§

impl<T> UnsafeUnpin for DelayQueue<T>
where Slab<Slot<T>>: 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more