Struct tokio_core::reactor::Timeout

pub struct Timeout { /* fields omitted */ }

A future representing the notification that a timeout has occurred.

Timeouts are created through the Timeout::new or Timeout::new_at methods indicating when a timeout should fire at. Note that timeouts are not intended for high resolution timers, but rather they will likely fire some granularity after the exact instant that they're otherwise indicated to fire at.

Methods

impl Timeout

fn new(dur: Duration, handle: &Handle) -> Result<Timeout>

Creates a new timeout which will fire at dur time into the future.

This function will return a future that will resolve to the actual timeout object. The timeout object itself is then a future which will be set to fire at the specified point in the future.

fn new_at(at: Instant, handle: &Handle) -> Result<Timeout>

Creates a new timeout which will fire at the time specified by at.

This function will return a future that will resolve to the actual timeout object. The timeout object itself is then a future which will be set to fire at the specified point in the future.

Trait Implementations

impl Future for Timeout

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = Error

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<(), Error>

Query this future to see if its value has become available, registering interest if it is not.

fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

fn boxed(self)
         -> Box<Future<Error=Self::Error, Item=Self::Item> + 'static + Send> where Self: Send + 'static

Convenience function for turning this future into a trait object which is also Send.

fn map<F, U>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Item) -> U

Map this future's result to a different type, returning a new future of the resulting type.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> E

Map this future's error to a different error, returning a new future.

fn from_err<E>(self) -> FromErr<Self, E> where E: From<Self::Error>

Map this future's error to any error implementing From for this future's Error, returning a new future.

fn then<F, B>(self, f: F) -> Then<Self, B, F> where B: IntoFuture, F: FnOnce(Result<Self::Item, Self::Error>) -> B

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where B: IntoFuture<Error=Self::Error>, F: FnOnce(Self::Item) -> B

Execute another future after this one has resolved successfully.

fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where B: IntoFuture<Item=Self::Item>, F: FnOnce(Self::Error) -> B

Execute another future if this one resolves with an error.

fn select<B>(self, other: B) -> Select<Self, B::Future> where B: IntoFuture<Item=Self::Item, Error=Self::Error>

Waits for either one of two futures to complete.

fn select2<B>(self, other: B) -> Select2<Self, B::Future> where B: IntoFuture

Waits for either one of two differently-typed futures to complete.

fn join<B>(self, other: B) -> Join<Self, B::Future> where B: IntoFuture<Error=Self::Error>

Joins the result of two futures, waiting for them both to complete.

fn join3<B, C>(self, b: B, c: C) -> Join3<Self, B::Future, C::Future> where B: IntoFuture<Error=Self::Error>, C: IntoFuture<Error=Self::Error>

Same as join, but with more futures.

fn join4<B, C, D>(self,
                  b: B,
                  c: C,
                  d: D)
                  -> Join4<Self, B::Future, C::Future, D::Future> where B: IntoFuture<Error=Self::Error>,
        C: IntoFuture<Error=Self::Error>,
        D: IntoFuture<Error=Self::Error>

Same as join, but with more futures.

fn join5<B, C, D, E>(self,
                     b: B,
                     c: C,
                     d: D,
                     e: E)
                     -> Join5<Self, B::Future, C::Future, D::Future, E::Future> where B: IntoFuture<Error=Self::Error>,
        C: IntoFuture<Error=Self::Error>,
        D: IntoFuture<Error=Self::Error>,
        E: IntoFuture<Error=Self::Error>

Same as join, but with more futures.

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

fn flatten(self) -> Flatten<Self> where Self::Item: IntoFuture, Self::Item::Error: From<Self::Error>

Flatten the execution of this future when the successful result of this future is itself another future.

fn flatten_stream(self) -> FlattenStream<Self> where Self::Item: Stream, Self::Item::Error == Self::Error

Flatten the execution of this future when the successful result of this future is a stream.

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe

Catches unwinding panics while polling the future.

fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.

impl Drop for Timeout

fn drop(&mut self)

A method called when the value goes out of scope.