Struct maitake::time::timeout::Timeout

source ·
pub struct Timeout<'timer, F> { /* private fields */ }
Expand description

A Future that requires an inner Future to complete within a specified Duration.

This Future is returned by the timeout and try_timeout functions, and by the Timer::timeout and Timer::try_timeout methods.

§Output

  • Ok(F::Output) if the inner future completed before the specified timeout.
  • Err(Elapsed) if the timeout elapsed before the inner Future completed.

§Cancellation

Dropping a Timeout future cancels the timeout. The wrapped Future can be extracted from the Timeout future by calling Timeout::into_inner, allowing the future to be polled without failing if the timeout elapses.

Implementations§

source§

impl<'timer, F: Future> Timeout<'timer, F>

source

pub fn into_inner(self) -> F

Consumes this Timeout, returning the inner Future.

This can be used to continue polling the inner Future without requiring it to complete prior to the specified timeout.

source

pub fn get_ref(&self) -> &F

Borrows the inner Future immutably.

source

pub fn get_mut(&mut self) -> &mut F

Mutably the inner Future.

source

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut F>

Borrows the inner Future as a Pinned reference, if this Timeout is pinned.

source

pub fn duration(&self) -> Duration

Returns the Duration the inner Future is allowed to run for.

Trait Implementations§

source§

impl<'timer, F: Debug> Debug for Timeout<'timer, F>

source§

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

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

impl<F: Future> Future for Timeout<'_, F>

§

type Output = Result<<F as Future>::Output, Elapsed>

The type of value produced on completion.
source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
source§

impl<'pin, 'timer, F> Unpin for Timeout<'timer, F>
where __Timeout<'pin, 'timer, F>: Unpin,

Auto Trait Implementations§

§

impl<'timer, F> !Freeze for Timeout<'timer, F>

§

impl<'timer, F> !RefUnwindSafe for Timeout<'timer, F>

§

impl<'timer, F> Send for Timeout<'timer, F>
where F: Send,

§

impl<'timer, F> !Sync for Timeout<'timer, F>

§

impl<'timer, F> !UnwindSafe for Timeout<'timer, F>

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> 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<F> IntoFuture for F
where F: Future,

§

type Output = <F as Future>::Output

The output that the future will produce on completion.
§

type IntoFuture = F

Which kind of future are we turning this into?
source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
source§

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

§

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>,

§

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