Struct actix::fut::StreamTimeout

#[must_use = "streams do nothing unless polled"]
pub struct StreamTimeout<S> where
    S: ActorStream + Unpin,  { /* 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 + Unpin, 

type Item = Result<S::Item, ()>

The type of item this stream will yield on success.

type Actor = S::Actor

The actor within which this stream runs.

fn poll_next(
    self: Pin<&mut Self>,
    act: &mut S::Actor,
    ctx: &mut <S::Actor as Actor>::Context,
    task: &mut Context
) -> Poll<Option<Result<S::Item, ()>>>

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,
    Self: Sized, 

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

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

Chain on a computation for when a value is ready, passing the resulting item 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, Output = T>,
    Self: Sized, 

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

fn timeout(self, timeout: Duration) -> StreamTimeout<Self> where
    Self: Sized + Unpin, 

Add timeout to stream.

fn finish(self) -> StreamFinish<Self> where
    Self: Sized + Unpin, 

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

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

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

Formats the value using the given formatter.