Trait TryStreamExt

pub trait TryStreamExt: TryStream + Sized {
    // Provided method
    fn timeout(self, dur: Duration) -> TimeoutStream<Self>
       where Self::Error: From<Error> { ... }
}

An extension trait for streams which provides convenient accessors for timing out execution and such.

Provided Methods

fn timeout(self, dur: Duration) -> TimeoutStream<Self>

where Self::Error: From<Error>,

Creates a new stream which will take at most dur time to yield each item of the stream.

This combinator creates a new stream which wraps the receiving stream in a timeout-per-item. The stream returned will resolve in at most dur time for each item yielded from the stream. The first item’s timer starts when this method is called.

If a stream’s item completes before dur elapses then the timer will be reset for the next item. If the timeout elapses, however, then an error will be yielded on the stream and the timer will be reset.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<S: TryStream> TryStreamExt for S