Struct TimeQueue

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

A time queue that delays yielding inserted elements until a fixed timeout has elapsed. Each inserted element is stored together with its expiration time (current Tokio Instant plus the constant timeout). Since the timeout is constant, the elements naturally expire in FIFO order, and both push and pop operations are O(1).

Implementations§

Source§

impl<T> TimeQueue<T>

Source

pub fn new(timeout: Duration) -> Self

Creates a new TimeQueue with the given timeout.

Source

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

Creates a new TimeQueue with the given timeout and reserves capacity for the underlying queue.

Source

pub fn push(&mut self, element: T)

Inserts an element into the queue. The element will be yielded after timeout has elapsed from the time of insertion.

Source

pub fn is_empty(&self) -> bool

Source

pub fn len(&self) -> usize

Trait Implementations§

Source§

impl<T> Stream for TimeQueue<T>

Source§

type Item = T

Values yielded by the stream.
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
Source§

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

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

impl<T> Unpin for TimeQueue<T>

Auto Trait Implementations§

§

impl<T> Freeze for TimeQueue<T>

§

impl<T> !RefUnwindSafe for TimeQueue<T>

§

impl<T> Send for TimeQueue<T>
where T: Send,

§

impl<T> Sync for TimeQueue<T>
where T: Sync,

§

impl<T> !UnwindSafe for TimeQueue<T>

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