futures_intrusive::channel::shared

Struct SharedStream

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

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§

Source§

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

Source

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§

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.
Source§

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

Source§

type Item = T

Values yielded by the stream.
Source§

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. Read more
Source§

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

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations§

§

impl<MutexType, T, A> Freeze for SharedStream<MutexType, T, A>

§

impl<MutexType, T, A> !RefUnwindSafe for SharedStream<MutexType, T, A>

§

impl<MutexType, T, A> Send for SharedStream<MutexType, T, A>
where MutexType: Sync + Send, T: Send, A: Send,

§

impl<MutexType, T, A> !Sync for SharedStream<MutexType, T, A>

§

impl<MutexType, T, A> !Unpin for SharedStream<MutexType, T, A>

§

impl<MutexType, T, A> !UnwindSafe for SharedStream<MutexType, T, A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more