Struct Pub

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

A publisher to a channel

Implementations

impl<'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Pub<'a, PSB, 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.

pub const fn sink(&self) -> PubSink<'a, '_, PSB, T>

Create a [futures::Sink] adapter for this publisher.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.