Struct CapacityTracker 

pub struct CapacityTracker { /* private fields */ }

Per-consumer tracker for current in-flight and buffered message counts.

Implementations

impl CapacityTracker

pub const fn new(capacity: ConsumerCapacity) -> Self

Creates a tracker for an explicitly declared consumer capacity.

pub const fn capacity(&self) -> &ConsumerCapacity

Returns the consumer capacity declaration this tracker follows.

pub const fn current_in_flight(&self) -> usize

Returns the number of messages currently being processed by the consumer.

pub const fn current_buffer_depth(&self) -> usize

Returns the number of messages currently buffered for the consumer.

pub const fn record_delivery(&mut self)

Records that a message was delivered and processing began.

pub const fn record_completion(&mut self) -> Result<(), CapacityError>

Records that processing completed for one in-flight message.

Errors

Returns CapacityError::InFlightUnderflow if no message is currently in flight.

pub const fn record_buffered(&mut self)

Records that a message was buffered pending consumer capacity.

pub const fn record_buffer_drained(&mut self) -> Result<(), CapacityError>

Records that one buffered message left the buffer.

Errors

Returns CapacityError::BufferUnderflow if no message is currently buffered.

pub const fn pressure_signal(&self) -> PressureSignal

Determines the pressure signal for the next message without mutating counters.

Trait Implementations

impl Clone for CapacityTracker

fn clone(&self) -> CapacityTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapacityTracker

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

Formats the value using the given formatter.

impl Eq for CapacityTracker

impl PartialEq for CapacityTracker

fn eq(&self, other: &CapacityTracker) -> 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 StructuralPartialEq for CapacityTracker