Struct tokio::time::Timeout

source · [−]

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

Expand description

Future returned by timeout and timeout_at.

Implementations

source

impl<T> Timeout<T>

source

pub fn get_ref(&self) -> &T

Gets a reference to the underlying value in this timeout.

source

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

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

source

pub fn into_inner(self) -> T

Consumes this timeout, returning the underlying value.

Trait Implementations

source

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

source

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

Formats the value using the given formatter. Read more

source

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

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

The type of value produced on completion.

source

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

Attempt 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, T> Unpin for Timeout<T> where
Origin<'__pin, T>: Unpin,

Auto Trait Implementations

impl<T> !RefUnwindSafe for Timeout<T>

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

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

impl<T> !UnwindSafe for Timeout<T>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

source

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

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct tokio::time::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::Output, Elapsed>

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for Timeout<T>

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

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

impl<T> !UnwindSafe for Timeout<T>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

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

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

type Error = Infallible

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

impl<F, T, E> TryFuture for F where F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

pub fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>) -> Poll<<F as Future>::Output>

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

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

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

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

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

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

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

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

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

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

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

impl<F> IntoFuture for F where
F: Future,

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

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

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