Struct embassy_sync::pubsub::subscriber::Subscriber

source · [−]

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

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>ⓘNotable traits for SubscriberWaitFuture<'s, 'a, PSB, T>`impl<'s, 'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Future for SubscriberWaitFuture<'s, 'a, PSB, T> type Output = WaitResult<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

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> !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
M: Sync,
T: Send,

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> Sync for Subscriber<'a, M, T, CAP, SUBS, PUBS>where
M: Sync,
T: Send + 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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct embassy_sync::pubsub::subscriber::Subscriber

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>ⓘNotable traits for SubscriberWaitFuture<'s, 'a, PSB, T>`impl<'s, 'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Future for SubscriberWaitFuture<'s, 'a, PSB, T> type Output = WaitResult<T>;`

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

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

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

pub fn available(&self) -> u64

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>

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

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

Auto Trait Implementations

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
M: Sync,
T: Send,

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> Sync for Subscriber<'a, M, T, CAP, SUBS, PUBS>where
M: Sync,
T: Send + 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 Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct embassy_sync::pubsub::subscriber::Subscriber

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>ⓘNotable traits for SubscriberWaitFuture<'s, 'a, PSB, T>impl<'s, 'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Future for SubscriberWaitFuture<'s, 'a, PSB, T> type Output = WaitResult<T>;

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

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

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

pub fn available(&self) -> u64

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>

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

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

Auto Trait Implementations

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 M: Sync, T: Send,

impl<'a, M, T, const CAP: usize, const SUBS: usize, const PUBS: usize> Sync for Subscriber<'a, M, T, CAP, SUBS, PUBS>where M: Sync, T: Send + 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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn next_message<'s>(&'s mut self) -> SubscriberWaitFuture<'s, 'a, PSB, T>ⓘNotable traits for SubscriberWaitFuture<'s, 'a, PSB, T>`impl<'s, 'a, PSB: PubSubBehavior<T> + ?Sized, T: Clone> Future for SubscriberWaitFuture<'s, 'a, PSB, T> type Output = WaitResult<T>;`

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

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

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

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

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

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

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

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