Struct embassy_sync::pubsub::publisher::Publisher

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

A publisher that holds a generic reference to the channel

Methods from Deref<Target = Pub<'a, PubSubChannel<M, T, CAP, SUBS, PUBS>, T>>

pub fn publish_immediate(&self, message: T)

Publish a message right now even when the queue is full. This may cause a subscriber to miss an older message.

pub fn publish<'s>(&'s self, message: T) -> PublisherWaitFuture<'s, 'a, PSB, T>

Publish a message. But if the message queue is full, wait for all subscribers to have read the last message

pub fn try_publish(&self, message: T) -> Result<(), T>

Publish a message if there is space in the message queue

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.

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 Publisher<'a, M, T, CAP, SUBS, PUBS>

type Target = Pub<'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 Publisher<'a, M, T, CAP, SUBS, PUBS>

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

Mutably dereferences the value.