Skip to main content

BackpressureBuffer

Struct BackpressureBuffer 

Source
pub struct BackpressureBuffer<T: Clone> {
    pub high_watermark: f64,
    pub low_watermark: f64,
    pub backpressure: bool,
    pub dropped: usize,
    /* private fields */
}
Expand description

A bounded ring buffer that signals backpressure when it becomes too full.

The high_watermark fraction (e.g. 0.8) determines when backpressure is activated; the low_watermark (e.g. 0.2) determines when it is released.

Fields§

§high_watermark: f64

Fraction of capacity at which backpressure is asserted (0.0–1.0).

§low_watermark: f64

Fraction of capacity at which backpressure is released (0.0–1.0).

§backpressure: bool

Current backpressure state.

§dropped: usize

Total items dropped due to backpressure.

Implementations§

Source§

impl<T: Clone> BackpressureBuffer<T>

Source

pub fn new(capacity: usize, high_watermark: f64, low_watermark: f64) -> Self

Create a new backpressure-aware buffer.

Source

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

Try to push an item. Returns false and increments dropped if backpressure is active or the buffer is full.

Source

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

Pop an item. May release backpressure if below low_watermark.

Source

pub fn fill_fraction(&self) -> f64

Current fill fraction (0.0–1.0).

Source

pub fn is_backpressure(&self) -> bool

Whether backpressure is currently active.

Source

pub fn len(&self) -> usize

Number of items in the buffer.

Source

pub fn is_empty(&self) -> bool

Is the buffer empty?

Trait Implementations§

Source§

impl<T: Debug + Clone> Debug for BackpressureBuffer<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 BackpressureBuffer<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for BackpressureBuffer<T>

§

impl<T> UnwindSafe for BackpressureBuffer<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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.