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: f64Fraction of capacity at which backpressure is asserted (0.0–1.0).
low_watermark: f64Fraction of capacity at which backpressure is released (0.0–1.0).
backpressure: boolCurrent backpressure state.
dropped: usizeTotal items dropped due to backpressure.
Implementations§
Source§impl<T: Clone> BackpressureBuffer<T>
impl<T: Clone> BackpressureBuffer<T>
Sourcepub fn new(capacity: usize, high_watermark: f64, low_watermark: f64) -> Self
pub fn new(capacity: usize, high_watermark: f64, low_watermark: f64) -> Self
Create a new backpressure-aware buffer.
Sourcepub fn push(&mut self, item: T) -> bool
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.
Sourcepub fn pop(&mut self) -> Option<T>
pub fn pop(&mut self) -> Option<T>
Pop an item. May release backpressure if below low_watermark.
Sourcepub fn fill_fraction(&self) -> f64
pub fn fill_fraction(&self) -> f64
Current fill fraction (0.0–1.0).
Sourcepub fn is_backpressure(&self) -> bool
pub fn is_backpressure(&self) -> bool
Whether backpressure is currently active.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.