Struct embassy_sync::pubsub::subscriber::Subscriber

pub struct Subscriber<'a, M: RawMutex, T: Clone, const CAP: usize, const SUBS: usize, const PUBS: usize>(/* private fields */);

A subscriber that holds a generic reference to the channel

Methods from Deref<Target = Sub<'a, PubSubChannel<M, T, CAP, SUBS, PUBS>, 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, M: RawMutex, T: Clone, const CAP: usize, const SUBS: usize, const PUBS: usize> Deref for Subscriber<'a, M, T, CAP, SUBS, PUBS>

type Target = Sub<'a, PubSubChannel<M, T, CAP, SUBS, PUBS>, T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, M: RawMutex, T: Clone, const CAP: usize, const SUBS: usize, const PUBS: usize> DerefMut for Subscriber<'a, M, T, CAP, SUBS, PUBS>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.