Struct embassy_sync::pubsub::subscriber::Subscriber

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

A subscriber that holds a generic reference to the channel

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

source

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

Wait for a published message

source

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

Wait for a published message (ignoring lag results)

source

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.

source

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.

source

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.

source

pub fn capacity(&self) -> usize

Returns the maximum number of elements the channel can hold.

source

pub fn free_capacity(&self) -> usize

Returns the free capacity of the channel.

This is equivalent to capacity() - len()

source

pub fn clear(&self)

Clears all elements in the channel.

source

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.

source

pub fn is_empty(&self) -> bool

Returns whether the channel is empty.

source

pub fn is_full(&self) -> bool

Returns whether the channel is full.

Trait Implementations§

source§

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.
source§

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

Dereferences the value.
source§

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

source§

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

Mutably dereferences the value.

Auto Trait Implementations§

§

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

§

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> !RefUnwindSafe for Subscriber<'a, M, T, CAP, SUBS, PUBS>

§

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> Send for Subscriber<'a, M, T, CAP, SUBS, PUBS>
where T: Send, M: Sync,

§

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> Sync for Subscriber<'a, M, T, CAP, SUBS, PUBS>
where T: Sync + Send, M: Sync,

§

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

§

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> !UnwindSafe for Subscriber<'a, M, T, CAP, SUBS, PUBS>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.