Skip to main content

AdmissionGuard

Struct AdmissionGuard 

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

A held transfer slot and its memory reservation. Releasing both is Drop, not a method, so no error path — and no panic — can skip it.

That is the whole answer to “an operation that ERRORS must still release”: there is no release call to forget, because unwinding runs Drop.

Implementations§

Source§

impl AdmissionGuard

Source

pub fn entered_service(&self)

The operation’s work has actually started. Files this item’s sojourn against its class’s window.

Called by the caller and not by the gate, because only the caller knows when the waiting stopped. In crate::server that is the first line of the spawned transfer task: everything between admission and there is the runtime’s ready queue and the blocking-pool handoff, which is exactly the invisible queue this whole module exists to make visible.

One-shot: a second call is ignored rather than filing a second, longer sample for the same item.

Source

pub fn class(&self) -> Option<OpClass>

The class this operation was admitted as.

Source

pub fn reserve_more(&self, bytes: u64) -> Option<Growth>

Charge this transfer for bytes more on the wire.

Called by the transport as bytes actually move, in either direction, and this is what makes the memory gate cost-based rather than flat: the admission reservation (OpClass::admission_bytes) is the entry cost, and everything proportional to the transfer arrives here.

Charges WIRE_MEMORY_NUMERATOR/WIRE_MEMORY_DENOMINATOR of the bytes, in steps of WIRE_RESERVE_STEP, so a per-byte quantity never becomes a per-byte decision. Returns Some(Growth) on the calls that actually charged and None in between, so a caller can log the overdraw without testing for it.

It cannot refuse — see Growth. What an overdraw does is stop new admissions until this transfer finishes.

Trait Implementations§

Source§

impl Debug for AdmissionGuard

Source§

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

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

impl Drop for AdmissionGuard

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§

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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