Struct CreditGate 

pub struct CreditGate { /* private fields */ }

Manages credits for a single receiver (core).

Thread-safe for use between sender and receiver threads.

Implementations

impl CreditGate

pub fn new(config: BackpressureConfig) -> Self

Creates a new credit gate with the given configuration.

pub fn try_acquire(&self) -> CreditAcquireResult

Attempts to acquire one credit.

Returns the result based on the overflow strategy.

pub fn try_acquire_n(&self, n: usize) -> CreditAcquireResult

Attempts to acquire N credits.

pub fn acquire_blocking(&self, n: usize)

Acquires credits, blocking with progressive backoff until available.

Only use when OverflowStrategy::Block is configured. Uses spin → yield → park progression to balance latency vs CPU waste.

pub fn release(&self, n: usize)

Releases credits back to the pool.

Called by receiver after processing data.

pub fn available(&self) -> usize

Returns the number of available credits.

pub fn max_credits(&self) -> usize

Returns the maximum credits.

pub fn is_backpressured(&self) -> bool

Returns true if backpressure is active (credits below threshold).

pub fn is_recovered(&self) -> bool

Returns true if backpressure has cleared (credits above low watermark).

pub fn config(&self) -> &BackpressureConfig

Returns the configuration.

pub fn metrics(&self) -> &CreditMetrics

Returns the metrics.

pub fn reset(&self)

Resets the gate to initial state.

Trait Implementations

impl Debug for CreditGate

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

Formats the value using the given formatter.