Skip to main content

BackpressureGuard

Struct BackpressureGuard 

Source
pub struct BackpressureGuard { /* private fields */ }
Expand description

Tracks in-flight work count and enforces a capacity limit.

§Guarantees

  • Thread-safe via Arc<Mutex<_>>
  • try_acquire is non-blocking
  • release decrements the counter; no-op if counter is already 0
  • Optional soft limit emits a warning when depth reaches the threshold

Implementations§

Source§

impl BackpressureGuard

Source

pub fn new(capacity: usize) -> Result<Self, AgentRuntimeError>

Create a new guard with the given capacity.

§Returns
  • Ok(BackpressureGuard) — on success
  • Err(AgentRuntimeError::Orchestration) — if capacity == 0
Source

pub fn with_soft_limit(self, soft: usize) -> Result<Self, AgentRuntimeError>

Set a soft capacity threshold. When depth reaches this level, a warning is logged but the request is still accepted (up to hard capacity).

Source

pub fn try_acquire(&self) -> Result<(), AgentRuntimeError>

Try to acquire a slot.

Emits a warning when the soft limit is reached (if configured), but still accepts the request until hard capacity is exceeded.

§Returns
  • Ok(()) — slot acquired
  • Err(AgentRuntimeError::BackpressureShed) — hard capacity exceeded
Source

pub fn release(&self) -> Result<(), AgentRuntimeError>

Release a previously acquired slot.

Source

pub fn hard_capacity(&self) -> usize

Return the hard capacity (maximum concurrent slots) configured for this guard.

Source

pub fn depth(&self) -> Result<usize, AgentRuntimeError>

Return the current depth.

Source

pub fn soft_depth_ratio(&self) -> f32

Return the ratio of current depth to soft capacity as a value in [0.0, ∞).

Returns 0.0 if no soft limit has been configured. Values above 1.0 mean the soft limit has been exceeded.

Trait Implementations§

Source§

impl Clone for BackpressureGuard

Source§

fn clone(&self) -> BackpressureGuard

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackpressureGuard

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more