Skip to main content

TrialGuard

Struct TrialGuard 

Source
pub struct TrialGuard<'b> { /* private fields */ }
Expand description

RAII guard for one admitted pull-through attempt.

Returned inside Admission::Proceed by OriginBreaker::acquire. It exists to make the HALF-OPEN trial budget cancellation-safe: a half-open trial reserves a half_open_in_flight slot at admission, and that slot must be returned even if the surrounding async fetch is cancelled (client disconnect / timeout) before its outcome is known.

Resolution happens exactly one of two ways:

  • TrialGuard::record commits the outcome — driving the CLOSED→OPEN, HALF-OPEN→CLOSED, and HALF-OPEN→OPEN transitions — and defuses the guard so Drop does nothing.
  • The guard is dropped without record (the future was cancelled): Drop releases the reserved HALF-OPEN slot (a no-op for a CLOSED admission, which reserves no slot) without recording any state transition. The breaker neither closes nor re-opens on a cancelled trial — it simply reclaims the budget so a later trial is admitted.

The guard borrows the breaker, so it cannot outlive it; the engine holds each breaker for the whole pull-through call, which strictly outlives the guard.

Implementations§

Source§

impl TrialGuard<'_>

Source

pub fn record(self, outcome: OriginOutcome)

Commit the outcome of the admitted attempt and defuse the guard.

Drives the breaker’s state transitions (the private OriginBreaker::record_committed) and clears owns_slot so the guard’s Drop does not also release the HALF-OPEN slot — record already accounts for the slot it resolves. For an inert guard (disabled policy) this is a no-op.

Trait Implementations§

Source§

impl<'b> Debug for TrialGuard<'b>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for TrialGuard<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'b> !RefUnwindSafe for TrialGuard<'b>

§

impl<'b> !UnwindSafe for TrialGuard<'b>

§

impl<'b> Freeze for TrialGuard<'b>

§

impl<'b> Send for TrialGuard<'b>

§

impl<'b> Sync for TrialGuard<'b>

§

impl<'b> Unpin for TrialGuard<'b>

§

impl<'b> UnsafeUnpin for TrialGuard<'b>

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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