Skip to main content

BackpressureController

Struct BackpressureController 

Source
pub struct BackpressureController {
    pub high_watermark: usize,
    pub low_watermark: usize,
    pub current_depth: usize,
    pub throttle_events: u64,
    /* private fields */
}
Expand description

Tracks backpressure between producers and consumers.

Fields§

§high_watermark: usize

Maximum queue depth before producer is throttled.

§low_watermark: usize

Queue depth at which throttling is released.

§current_depth: usize

Current queue depth.

§throttle_events: u64

Total times throttling was applied.

Implementations§

Source§

impl BackpressureController

Source

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

Create a backpressure controller.

Source

pub fn enqueue(&mut self)

Record that one item was enqueued.

Source

pub fn dequeue(&mut self)

Record that one item was dequeued.

Source

pub fn is_throttled(&self) -> bool

Whether the producer should be throttled.

Source

pub fn fill_ratio(&self) -> f64

Fill ratio (0.0 = empty, 1.0 = at high watermark).

Source

pub fn reset(&mut self)

Reset depth and throttle state.

Auto Trait Implementations§

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.