[−][src]Struct tokio::timer::timeout::Timeout
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 Timeout::into_inner
. This
consumes the Timeout
.
Methods
impl<T> Timeout<T>
[src]
impl<T> Timeout<T>
pub fn new(value: T, timeout: Duration) -> 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))
ⓘImportant traits for &'a mut W
pub fn get_ref(&self) -> &T | [src] |
Gets a reference to the underlying value in this timeout.
ⓘImportant traits for &'a mut W
pub fn get_mut(&mut self) -> &mut T | [src] |
Gets a mutable reference to the underlying value in this timeout.
pub fn into_inner(self) -> T | [src] |
Consumes this timeout, returning the underlying value.
impl<T> Timeout<T> where
T: Future,
[src]
impl<T> Timeout<T> where
T: Future,
pub fn new_at(future: T, deadline: Instant) -> 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> Stream for Timeout<T> where
T: Stream,
[src]
impl<T> Stream for Timeout<T> where
T: Stream,
type Item = <T as Stream>::Item
The type of item this stream will yield on success.
type Error = Error<<T as Stream>::Error>
The type of error this stream may generate.
fn poll( | [src] |
ⓘImportant traits for Wait<S>
fn wait(self) -> Wait<Self> | [src] |
Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more
fn into_future(self) -> StreamFuture<Self> | [src] |
Converts this stream into a Future
. Read more
fn map<U, F>(self, f: F) -> Map<Self, F> where | [src] |
Converts a stream of type T
to a stream of type U
. Read more
fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where | [src] |
Converts a stream of error type T
to a stream of error type U
. Read more
fn filter<F>(self, f: F) -> Filter<Self, F> where | [src] |
Filters the values produced by this stream according to the provided predicate. Read more
fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where | [src] |
Filters the values produced by this stream while simultaneously mapping them to a different type. Read more
fn then<F, U>(self, f: F) -> Then<Self, F, U> where | [src] |
Chain on a computation for when a value is ready, passing the resulting item to the provided closure f
. Read more
fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where | [src] |
Chain on a computation for when a value is ready, passing the successful results to the provided closure f
. Read more
fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where | [src] |
Chain on a computation for when an error happens, passing the erroneous result to the provided closure f
. Read more
fn collect(self) -> Collect<Self> | [src] |
Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more
fn concat2(self) -> Concat2<Self> where | [src] |
Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more
fn concat(self) -> Concat<Self> where | [src] |
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
fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where | [src] |
Execute an accumulating computation over a stream, collecting all the values into one final result. Read more
fn flatten(self) -> Flatten<Self> where | [src] |
Flattens a stream of streams into just one continuous stream. Read more
fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where | [src] |
Skip elements on this stream while the predicate provided resolves to true
. Read more
fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where | [src] |
Take elements from this stream while the predicate provided resolves to true
. Read more
fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where | [src] |
Runs this stream to completion, executing the provided closure for each element on the stream. Read more
fn from_err<E>(self) -> FromErr<Self, E> where | [src] |
Map this stream's error to any error implementing From
for this stream's Error
, returning a new stream. Read more
fn take(self, amt: u64) -> Take<Self> | [src] |
Creates a new stream of at most amt
items of the underlying stream. Read more
fn skip(self, amt: u64) -> Skip<Self> | [src] |
Creates a new stream which skips amt
items of the underlying stream. Read more
fn fuse(self) -> Fuse<Self> | [src] |
Fuse a stream such that poll
will never again be called once it has finished. Read more
ⓘImportant traits for &'a mut W
fn by_ref(&mut self) -> &mut Self | [src] |
Borrows a stream, rather than consuming it. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where | [src] |
Catches unwinding panics while polling the stream. Read more
fn buffered(self, amt: usize) -> Buffered<Self> where | [src] |
An adaptor for creating a buffered list of pending futures. Read more
fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where | [src] |
An adaptor for creating a buffered list of pending futures (unordered). Read more
fn merge<S>(self, other: S) -> Merge<Self, S> where | [src] |
functionality provided by select
now
An adapter for merging the output of two streams. Read more
fn zip<S>(self, other: S) -> Zip<Self, S> where | [src] |
An adapter for zipping two streams together. Read more
fn chain<S>(self, other: S) -> Chain<Self, S> where | [src] |
Adapter for chaining two stream. Read more
fn peekable(self) -> Peekable<Self> | [src] |
Creates a new stream which exposes a peek
method. Read more
fn chunks(self, capacity: usize) -> Chunks<Self> | [src] |
An adaptor for chunking up items of the stream inside a vector. Read more
fn select<S>(self, other: S) -> Select<Self, S> where | [src] |
Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more
fn forward<S>(self, sink: S) -> Forward<Self, S> where | [src] |
A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where | [src] |
Splits this Stream + Sink
object into separate Stream
and Sink
objects. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where | [src] |
Do something with each item of this stream, afterwards passing it on. Read more
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where | [src] |
Do something with the error of this stream, afterwards passing it on. Read more
impl<T> Future for Timeout<T> where
T: Future,
[src]
impl<T> Future for Timeout<T> where
T: Future,
type Item = <T as Future>::Item
The type of value that this future will resolved with if it is successful. Read more
type Error = Error<<T as Future>::Error>
The type of error that this future will resolve with if it fails in a normal fashion. Read more
fn poll( | [src] |
fn wait(self) -> Result<Self::Item, Self::Error> | [src] |
Block the current thread until this future is resolved. Read more
fn map<F, U>(self, f: F) -> Map<Self, F> where | [src] |
Map this future's result to a different type, returning a new future of the resulting type. Read more
fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where | [src] |
Map this future's error to a different error, returning a new future. Read more
fn from_err<E>(self) -> FromErr<Self, E> where | [src] |
Map this future's error to any error implementing From
for this future's Error
, returning a new future. Read more
fn then<F, B>(self, f: F) -> Then<Self, B, F> where | [src] |
Chain on a computation for when a future finished, passing the result of the future to the provided closure f
. Read more
fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where | [src] |
Execute another future after this one has resolved successfully. Read more
fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where | [src] |
Execute another future if this one resolves with an error. Read more
fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where | [src] |
Waits for either one of two futures to complete. Read more
fn select2<B>(self, other: B) -> Select2<Self, <B as IntoFuture>::Future> where | [src] |
Waits for either one of two differently-typed futures to complete. Read more
fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where | [src] |
Joins the result of two futures, waiting for them both to complete. Read more
fn join3<B, C>( | [src] |
Same as join
, but with more futures.
fn join4<B, C, D>( | [src] |
Same as join
, but with more futures.
fn join5<B, C, D, E>( | [src] |
Same as join
, but with more futures.
fn into_stream(self) -> IntoStream<Self> | [src] |
Convert this future into a single element stream. Read more
fn flatten(self) -> Flatten<Self> where | [src] |
Flatten the execution of this future when the successful result of this future is itself another future. Read more
fn flatten_stream(self) -> FlattenStream<Self> where | [src] |
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self> | [src] |
Fuse a future such that poll
will never again be called once it has completed. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where | [src] |
Do something with the item of a future, passing it on. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where | [src] |
Catches unwinding panics while polling the future. Read more
fn shared(self) -> Shared<Self> | [src] |
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
impl<T> Debug for Timeout<T> where
T: Debug,
[src]
impl<T> Debug for Timeout<T> where
T: Debug,
Auto Trait Implementations
Blanket Implementations
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> | [src] |
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId | [src] |
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'a mut W
fn borrow_mut(&mut self) -> &mut T | [src] |
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> | [src] |
impl<F> IntoFuture for F where
F: Future,
[src]
impl<F> IntoFuture for F where
F: Future,
type Future = F
The future that this type can be converted into.
type Item = <F as Future>::Item
The item that the future may resolve with.
type Error = <F as Future>::Error
The error that the future may resolve with.
fn into_future(self) -> F | [src] |
impl<T> Erased for T
impl<T> Erased for T