Skip to main content

BoundedRing

Struct BoundedRing 

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

A FIFO queue capped at cap items; a push into a full ring evicts the oldest.

Implementations§

Source§

impl<T> BoundedRing<T>

Source

pub fn new(cap: usize) -> Self

A ring holding at most cap items. cap must be positive.

Source

pub fn push(&mut self, item: T) -> Option<T>

Enqueue item. If the ring is already full, the OLDEST item is evicted first (and counted in dropped); the evicted item is returned so the caller can telemeter it.

Source

pub fn pop(&mut self) -> Option<T>

Dequeue the oldest surviving item (FIFO).

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn is_full(&self) -> bool

Source

pub fn capacity(&self) -> usize

Source

pub fn dropped(&self) -> u64

The number of items shed to overflow since construction — the drop telemetry the congestion controller reads to lower the send rate.

Trait Implementations§

Source§

impl<T: Clone> Clone for BoundedRing<T>

Source§

fn clone(&self) -> BoundedRing<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for BoundedRing<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for BoundedRing<T>

§

impl<T> RefUnwindSafe for BoundedRing<T>
where T: RefUnwindSafe,

§

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

§

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

§

impl<T> Unpin for BoundedRing<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for BoundedRing<T>

§

impl<T> UnwindSafe for BoundedRing<T>
where T: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.