Skip to main content

InFlight

Struct InFlight 

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

One request that has not finished.

Implementations§

Source§

impl InFlight

Source

pub fn new( origin: RequestOrigin, method: impl AsRef<str>, token: Option<ProgressToken>, budget: Option<Duration>, started_at: Instant, ) -> Self

A newly registered request.

budget is how long this side is willing to wait. None means the caller decided the request is not time-bounded — which is a decision, not an oversight, and is why it is an Option rather than a zero that would expire on the next tick.

Source

pub const fn origin(&self) -> RequestOrigin

Which side issued it.

Source

pub fn method(&self) -> &str

The method it names.

Source

pub const fn progress_token(&self) -> Option<&ProgressToken>

The progress token the request carried, if it asked for progress.

Source

pub const fn budget(&self) -> Option<Duration>

How long this side is willing to wait, if it decided.

Source

pub const fn started_at(&self) -> Instant

When it was registered.

Source

pub const fn cancellation(&self) -> &CancellationToken

The handle a handler awaits to learn it was cancelled.

Source

pub fn cancellation_handle(&self) -> CancellationToken

A clone of the cancellation handle, safe to hold across an await.

The registry hands out &InFlight only while its lock is taken, so a handler that wants to wait has to own the token rather than borrow it out of the table.

Source

pub fn has_expired(&self, now: Instant) -> bool

Whether the budget is spent at now.

Source

pub fn advance_progress( &mut self, progress: f64, message: Option<String>, ) -> bool

Records a progress value and says whether it should go on the wire.

false for a request that carried no token, because there is nothing to correlate the notification to, and for a value that does not move the cursor forward. Delegates to this entry’s own cursor, so a caller cannot accidentally check monotonicity against another request’s last value.

Source

pub const fn furthest_progress(&self) -> Option<f64>

The furthest progress reported for this request.

Source

pub fn abort(&self, reason: AbortReason) -> bool

Aborts the request.

Returns whether this call is the one that published the reason.

Trait Implementations§

Source§

impl Debug for InFlight

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<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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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