Struct QueueCaps 

#[non_exhaustive]
pub struct QueueCaps {
    pub max_items: usize,
    pub soft_items: usize,
    pub max_bytes: Option<usize>,
    pub soft_bytes: Option<usize>,
}

Queue capacity and watermark configuration.

soft_* define backpressure watermarks; max_* define hard caps. Watermark state is derived from live occupancy snapshots and drives scheduling/backpressure.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_items: usize

Maximum number of items permitted (hard cap).

soft_items: usize

Soft watermark for items; admission adapts between soft and hard.

max_bytes: Option<usize>

Optional byte cap and soft watermark for payload sizes.

soft_bytes: Option<usize>

Optional soft watermark in bytes.

Implementations

impl QueueCaps

pub const fn new( max_items: usize, soft_items: usize, max_bytes: Option<usize>, soft_bytes: Option<usize>, ) -> Self

Construct new queue caps.

pub const fn max_items(&self) -> &usize

Borrow max_items.

pub const fn soft_items(&self) -> &usize

Borrow soft_items.

pub const fn max_bytes(&self) -> &Option<usize>

Borrow max_bytes.

pub const fn soft_bytes(&self) -> &Option<usize>

Borrow soft_bytes.

pub fn below_soft(&self, items: usize, bytes: usize) -> bool

Return true if the given occupancy is below soft watermarks.

pub fn at_or_above_hard(&self, items: usize, bytes: usize) -> bool

Return true if the occupancy is at or above hard cap.

Trait Implementations

impl Clone for QueueCaps

fn clone(&self) -> QueueCaps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueueCaps

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

Formats the value using the given formatter.

impl PartialEq for QueueCaps

fn eq(&self, other: &QueueCaps) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for QueueCaps

impl Eq for QueueCaps

impl StructuralPartialEq for QueueCaps