Struct tokio_core::reactor::Interval

pub struct Interval { /* fields omitted */ }

A stream representing notifications at fixed interval

Intervals are created through the Interval::new or Interval::new_at methods indicating when a first notification should be triggered and when it will be repeated.

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 Interval

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

Creates a new interval which will fire at dur time into the future, and will repeat every dur interval after

This function will return a future that will resolve to the actual interval object. The interval object itself is then a stream which will be set to fire at the specified intervals

fn new_at(at: Instant, dur: Duration, handle: &Handle) -> Result<Interval>

Creates a new interval which will fire at the time specified by at, and then will repeat every dur interval after

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 Stream for Interval

type Item = ()

The type of item this stream will yield on success.

type Error = Error

The type of error this stream may generate.

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

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

fn wait(self) -> Wait<Self>

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

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

Convenience function for turning this stream into a trait object.

fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

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

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

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

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

fn filter<F>(self, f: F) -> Filter<Self, F> where F: FnMut(&Self::Item) -> bool

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

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>

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

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

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

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

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

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

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

fn collect(self) -> Collect<Self>

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

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where F: FnMut(T, Self::Item) -> Fut, Fut: IntoFuture<Item=T>, Self::Error: From<Fut::Error>

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

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

Flattens a stream of streams into just one continuous stream.

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where P: FnMut(&Self::Item) -> R, R: IntoFuture<Item=bool, Error=Self::Error>

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

fn for_each<F>(self, f: F) -> ForEach<Self, F> where F: FnMut(Self::Item) -> Result<(), Self::Error>

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

fn take(self, amt: u64) -> Take<Self>

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

fn skip(self, amt: u64) -> Skip<Self>

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

fn fuse(self) -> Fuse<Self>

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

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

Catches unwinding panics while polling the stream.

fn buffered(self, amt: usize) -> Buffered<Self> where Self::Item: IntoFuture, Self::Item::Error == Self::Error

An adaptor for creating a buffered list of pending futures.

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where Self::Item: IntoFuture, Self::Item::Error == Self::Error

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

fn merge<S>(self, other: S) -> Merge<Self, S> where S: Stream<Error=Self::Error>

An adapter for merging the output of two streams.

fn zip<S>(self, other: S) -> Zip<Self, S> where S: Stream<Error=Self::Error>

An adapter for zipping two streams together.

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

fn chunks(self, capacity: usize) -> Chunks<Self>

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

fn select<S>(self, other: S) -> Select<Self, S> where S: Stream<Item=Self::Item, Error=Self::Error>

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

fn forward<S>(self, sink: S) -> Forward<Self, S> where S: Sink<SinkItem=Self::Item>, Self::Error: From<S::SinkError>

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

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where Self: Sink

Splits this Stream + Sink object into separate Stream and Sink objects, which can be useful when you want to split ownership between tasks, or allow direct interaction between the two objects (e.g. via Sink::send_all).

impl Drop for Interval

fn drop(&mut self)

A method called when the value goes out of scope.