Struct futures_intrusive::channel::shared::SharedStream

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

A stream that receives from channel using a GenericReceiver.

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

Implementations

impl<MutexType, T, A> SharedStream<MutexType, T, A>where
    MutexType: RawMutex,
    A: 'static + RingBuf<Item = T>,

pub fn close(&self) -> CloseStatus

Closes the channel. All pending and future send attempts will fail. Receive attempts will continue to succeed as long as there are items stored inside the channel. Further attempts will fail.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<MutexType, T, A> FusedStream for SharedStream<MutexType, T, A>where
    MutexType: RawMutex,
    A: 'static + RingBuf<Item = T>,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<MutexType, T, A> Stream for SharedStream<MutexType, T, A>where
    MutexType: RawMutex,
    A: 'static + RingBuf<Item = T>,

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.