Struct Timeout

pub struct Timeout<T> { /* private fields */ }

Available on crate feature time only.

Future returned by timeout and timeout_at.

Implementations

impl<T> Timeout<T>

pub fn get_ref(&self) -> &T

Gets a reference to the underlying value in this timeout.

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

Gets a mutable reference to the underlying value in this timeout.

pub fn into_inner(self) -> T

Consumes this timeout, returning the underlying value.

Trait Implementations

impl<T: Debug> Debug for Timeout<T>

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

Formats the value using the given formatter. Read more

impl<T> Future for Timeout<T>
where T: Future,

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

The type of value produced on completion.

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

impl<'pin, T> Unpin for Timeout<T>
where PinnedFieldsOf<Origin<'__pin, T>>: Unpin,

Auto Trait Implementations

impl<T> !Freeze for Timeout<T>

impl<T> !RefUnwindSafe for Timeout<T>

impl<T> !UnsafeUnpin for Timeout<T>

impl<T> !UnwindSafe for Timeout<T>

impl<T> Send for Timeout<T>
where T: Send,

impl<T> Sync for Timeout<T>
where T: Sync,

Blanket Implementations

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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?

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

Creates a future from a value. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

Struct Timeout

Implementations

impl<T> Timeout<T>

pub fn get_ref(&self) -> &T

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

pub fn into_inner(self) -> T

Trait Implementations

impl<T: Debug> Debug for Timeout<T>

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

impl<T> Future for Timeout<T>where T: Future,

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

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

impl<'__pin, T> Unpin for Timeout<T>where PinnedFieldsOf<__Origin<'__pin, T>>: Unpin,

Auto Trait Implementations

impl<T> !Freeze for Timeout<T>

impl<T> !RefUnwindSafe for Timeout<T>

impl<T> !UnsafeUnpin for Timeout<T>

impl<T> !UnwindSafe for Timeout<T>

impl<T> Send for Timeout<T>where T: Send,

impl<T> Sync for Timeout<T>where T: Sync,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for Fwhere F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

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

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>