Struct tokio_timer::Timeout[−][src]

#[must_use = "futures do nothing unless polled"]

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

Allows a Future or Stream to execute for a limited amount of time.

If the future or stream completes before the timeout has expired, then Timeout returns the completed value. Otherwise, Timeout returns an Error.

Futures and Streams

The exact behavor depends on if the inner value is a Future or a Stream. In the case of a Future, Timeout will require the future to complete by a fixed deadline. In the case of a Stream, Timeout will allow each item to take the entire timeout before returning an error.

In order to set an upper bound on the processing of the entire stream, then a timeout should be set on the future that processes the stream. For example:

// import the `timeout` function, usually this is done
// with `use tokio::prelude::*`
use tokio::prelude::FutureExt;
use futures::Stream;
use futures::sync::mpsc;
use std::time::Duration;

let (tx, rx) = mpsc::unbounded();

let process = rx.for_each(|item| {
    // do something with `item`
});

// Wrap the future with a `Timeout` set to expire in 10 milliseconds.
process.timeout(Duration::from_millis(10))

Cancelation

Cancelling a Timeout is done by dropping the value. No additional cleanup or other work is required.

The original future or stream may be obtained by calling [into_inner]. This consumes the Timeout.

Methods

impl<T> Timeout<T>
[src]

Create a new Timeout that allows value to execute for a duration of at most timeout.

The exact behavior depends on if value is a Future or a Stream.

See type level documentation for more details.

Examples

Create a new Timeout set to expire in 10 milliseconds.

use tokio::timer::Timeout;
use futures::Future;
use futures::sync::oneshot;
use std::time::Duration;

let (tx, rx) = oneshot::channel();

// Wrap the future with a `Timeout` set to expire in 10 milliseconds.
Timeout::new(rx, Duration::from_millis(10))

Gets a reference to the underlying value in this timeout.

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

Consumes this timeout, returning the underlying value.

impl<T: Future> Timeout<T>
[src]

Create a new Timeout that completes when future completes or when deadline is reached.

This function differs from new in that:

  • It only accepts Future arguments.
  • It sets an explicit Instant at which the timeout expires.

Trait Implementations

impl<T: Debug> Debug for Timeout<T>
[src]

Formats the value using the given formatter. Read more

impl<T> Future for Timeout<T> where
    T: Future, 
[src]

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

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

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

Block the current thread until this future is resolved. Read more

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

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

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

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

Execute another future after this one has resolved successfully. Read more

Execute another future if this one resolves with an error. Read more

Waits for either one of two futures to complete. Read more

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

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

Same as join, but with more futures.

Same as join, but with more futures.

Same as join, but with more futures.

Convert this future into a single element stream. Read more

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

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

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

Do something with the item of a future, passing it on. Read more

Catches unwinding panics while polling the future. Read more

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

impl<T> Stream for Timeout<T> where
    T: Stream, 
[src]

The type of item this stream will yield on success.

The type of error this stream may generate.

Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more

Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more

Converts this stream into a Future. Read more

Converts a stream of type T to a stream of type U. Read more

Converts a stream of error type T to a stream of error type U. Read more

Filters the values produced by this stream according to the provided predicate. Read more

Filters the values produced by this stream while simultaneously mapping them to a different type. Read more

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

Deprecated since 0.1.14

: please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

Execute an accumulating computation over a stream, collecting all the values into one final result. Read more

Flattens a stream of streams into just one continuous stream. Read more

Skip elements on this stream while the predicate provided resolves to true. Read more

Take elements from this stream while the predicate provided resolves to true. Read more

Runs this stream to completion, executing the provided closure for each element on the stream. Read more

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

Creates a new stream of at most amt items of the underlying stream. Read more

Creates a new stream which skips amt items of the underlying stream. Read more

Fuse a stream such that poll will never again be called once it has finished. Read more

Borrows a stream, rather than consuming it. Read more

Catches unwinding panics while polling the stream. Read more

An adaptor for creating a buffered list of pending futures. Read more

An adaptor for creating a buffered list of pending futures (unordered). Read more

Deprecated

: functionality provided by select now

An adapter for merging the output of two streams. Read more

An adapter for zipping two streams together. Read more

Adapter for chaining two stream. Read more

Creates a new stream which exposes a peek method. Read more

An adaptor for chunking up items of the stream inside a vector. Read more

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

Splits this Stream + Sink object into separate Stream and Sink objects. Read more

Do something with each item of this stream, afterwards passing it on. Read more

Do something with the error of this stream, afterwards passing it on. Read more

Auto Trait Implementations

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

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