Struct futures_intrusive::channel::ChannelStream

pub struct ChannelStream<'a, MutexType: RawMutex, T, A>where
    A: RingBuf<Item = T>,{ /* private fields */ }

A stream that receives from a GenericChannel.

Not driving the ChannelStream to completion after it has been polled might lead to lost wakeup notifications.

Trait Implementations

impl<'a, MutexType: Debug + RawMutex, T: Debug, A: Debug> Debug for ChannelStream<'a, MutexType, T, A>where
    A: RingBuf<Item = T>,

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

Formats the value using the given formatter.

impl<'a, MutexType, T, A> FusedStream for ChannelStream<'a, MutexType, T, A>where
    A: RingBuf<Item = T>,
    MutexType: RawMutex,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<'a, MutexType, T, A> Stream for ChannelStream<'a, MutexType, T, A>where
    A: RingBuf<Item = T>,
    MutexType: RawMutex,

type Item = T

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.