Struct lifeline::subscription::Receiver

pub struct Receiver<T> { /* fields omitted */ }

A receiver which provides SubscriptionState messages. Returns immediately on the first recv(), and then waits for subscription updates. Also provides .contains(id) and .get_identifier(id) utility methods, which are non-blocking.

Implementations

impl<T> Receiver<T>

pub fn new(rx: Receiver<SubscriptionState<T>>) -> Self

impl<T: Hash + Eq> Receiver<T>

pub fn contains(&self, id: &T) -> bool

Returns true if the subscription channel is currently subscribed to the given identifier

pub fn get_identifier(&self, id: &T) -> Option<usize>

Returns a unique index for the subscription on the given identifier, or None if the channel is not subscribed to the identifier.

impl<T: Clone> Receiver<T>

pub async fn recv<'_>(&'_ mut self) -> Option<SubscriptionState<T>>

Trait Implementations

impl<T> Clone for Receiver<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Receiver<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Receiver<SubscriptionState<T>> for Receiver<T> where
    T: Clone + Debug + Send + Sync, 

fn recv<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Option<SubscriptionState<T>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

impl<T: Send + 'static> Storage for Receiver<T>

fn take_or_clone(res: &mut Option<Self>) -> Option<Self>

If Self::Tx implements clone, clone it. Otherwise use Option::take

fn clone_slot(res: &mut Option<Self>) -> Option<Self> where
    Self: Clone, 

Helper which clones the provided option, requiring that Self: Clone

fn take_slot(res: &mut Option<Self>) -> Option<Self>

Helper which takes the provided option, returning None if it's already been taken