Struct Sub 

pub struct Sub<'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> { /* private fields */ }

A subscriber to a channel

Implementations

impl<'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Sub<'a, PSB, T>

pub fn next_message<'s>(&'s mut self) -> SubscriberWaitFuture<'s, 'a, PSB, T>

Wait for a published message

pub async fn next_message_pure(&mut self) -> T

Wait for a published message (ignoring lag results)

pub fn try_next_message(&mut self) -> Option<WaitResult<T>>

Try to see if there’s a published message we haven’t received yet.

This function does not peek. The message is received if there is one.

pub fn try_next_message_pure(&mut self) -> Option<T>

Try to see if there’s a published message we haven’t received yet (ignoring lag results).

This function does not peek. The message is received if there is one.

pub fn available(&self) -> u64

The amount of messages this subscriber hasn’t received yet. This is like Self::len but specifically for this subscriber.

pub fn capacity(&self) -> usize

Returns the maximum number of elements the channel can hold.

pub fn free_capacity(&self) -> usize

Returns the free capacity of the channel.

This is equivalent to capacity() - len()

pub fn clear(&self)

Clears all elements in the channel.

pub fn len(&self) -> usize

Returns the number of elements currently in the channel. See Self::available for how many messages are available for this subscriber.

pub fn is_empty(&self) -> bool

Returns whether the channel is empty.

pub fn is_full(&self) -> bool

Returns whether the channel is full.

Trait Implementations

impl<'a, PSB: Debug + PubSubBehavior<T> + ?Sized, T: Debug + Clone> Debug for Sub<'a, PSB, T>

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

Formats the value using the given formatter.

impl<'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Drop for Sub<'a, PSB, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Stream for Sub<'a, PSB, T>

Warning: The stream implementation ignores lag results and returns all messages. This might miss some messages without you knowing it.

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.

impl<'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Unpin for Sub<'a, PSB, T>