Struct zbus::SignalStream

pub struct SignalStream<'a> { /* private fields */ }

A stream::Stream implementation that yields signal messages.

Use Proxy::receive_signal to create an instance of this type.

This type uses a MessageStream::for_match_rule internally and therefore the note about match rule registration and AsyncDrop in its documentation applies here as well.

Implementations

impl<'a> SignalStream<'a>

pub fn name(&self) -> Option<&MemberName<'a>>

The signal name.

Trait Implementations

impl AsyncDrop for SignalStream<'_>

fn async_drop<'async_trait>( self ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait,

Perform the async cleanup.

impl<'a> Debug for SignalStream<'a>

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

Formats the value using the given formatter.

impl<'a> FusedStream for SignalStream<'a>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<'a> OrderedStream for SignalStream<'a>

type Data = Arc<Message>

The unordered data carried by this stream

type Ordering = MessageSequence

The type ordered by this stream.

fn poll_next_before( self: Pin<&mut Self>, cx: &mut Context<'_>, before: Option<&Self::Ordering> ) -> Poll<PollResult<Self::Ordering, Self::Data>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if needed, and returning NoneBefore if it is known that the stream will not produce any more values ordered before the given point.

fn position_hint(&self) -> Option<MaybeBorrowed<'_, Self::Ordering>>

The minimum value of the ordering for any future items.

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

Returns the bounds on the remaining length of the stream.

impl<'a> Stream for SignalStream<'a>

type Item = Arc<Message>

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.