Struct actix_web::actix::fut::StreamTimeout

#[must_use = "streams do nothing unless polled"]
pub struct StreamTimeout<S> where
    S: ActorStream,  { /* fields omitted */ }

Future for the timeout combinator, interrupts computations if it takes more than timeout.

This is created by the ActorFuture::timeout() method.

Trait Implementations

impl<S> ActorStream for StreamTimeout<S> where
    S: ActorStream,
    <S as ActorStream>::Error: Clone, 

type Item = <S as ActorStream>::Item

The type of item this stream will yield on success.

type Error = <S as ActorStream>::Error

The type of error this stream may generate.

type Actor = <S as ActorStream>::Actor

The actor within which this stream runs.

fn poll(
    &mut self,
    act: &mut <S as ActorStream>::Actor,
    ctx: &mut <<S as ActorStream>::Actor as Actor>::Context
) -> Result<Async<Option<<S as ActorStream>::Item>>, <S as ActorStream>::Error>

fn map<U, F>(self, f: F) -> StreamMap<Self, F> where
    F: FnMut(Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> U, 

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

fn map_err<E, F>(self, f: F) -> StreamMapErr<Self, F> where
    F: FnMut(Self::Error, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> E, 

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

fn then<F, U>(self, f: F) -> StreamThen<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> U,
    U: IntoActorFuture<Actor = Self::Actor>, 

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) -> StreamAndThen<Self, F, U> where
    F: FnMut(Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> U,
    U: IntoActorFuture<Error = Self::Error, Actor = Self::Actor>, 

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

fn fold<F, T, Fut>(self, init: T, f: F) -> StreamFold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context) -> Fut,
    Fut: IntoActorFuture<Actor = Self::Actor, Item = T>,
    Self::Error: From<<Fut as IntoActorFuture>::Error>, 

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

fn timeout(self, timeout: Duration, err: Self::Error) -> StreamTimeout<Self> where
    Self::Error: Clone, 

Add timeout to stream.

fn finish(self) -> StreamFinish<Self>

Converts a stream to a future that resolves when stream finishes.

impl<S> Debug for StreamTimeout<S> where
    S: Debug + ActorStream,
    <S as ActorStream>::Error: Debug, 

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.