Struct lifeline::subscription::Sender

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

A sender which takes Subscription::Subscribe(id) and Subscription::Unsubscribe(id) messages

Implementations

impl<T> Sender<T>

pub async fn send<'_>(
    &'_ mut self,
    subscription: Subscription<T>
) -> Result<(), SendError<Subscription<T>>>

pub fn try_send(
    &mut self,
    subscription: Subscription<T>
) -> Result<(), TrySendError<Subscription<T>>>

Trait Implementations

impl<T> Channel for Sender<T> where
    T: Hash + Eq + Clone + Debug + Send + Sync + 'static, 

type Tx = Sender<T>

The Sender half of the channel. This is used in Message implementations to attach channels to a Bus.

type Rx = Receiver<T>

The Receiver half of the channel. This is constructed when bus.tx or bus.rx is called, and is driven by the Message implementation for the message.

fn channel(capacity: usize) -> (Self::Tx, Self::Rx)

Constructs a new (Sender, Receiver) pair. If the channel is bounded, use the provided capacity.

fn default_capacity() -> usize

If the channel is bounded, provide a default capacity hint. Users can override this with bus.capacity(usize)

fn clone_tx(tx: &mut Option<Self::Tx>) -> Option<Self::Tx>

Clones the Self::Tx value, or takes it from the option if this endpoint is not cloneable.

fn clone_rx(
    rx: &mut Option<Self::Rx>,
    _tx: Option<&Self::Tx>
) -> Option<Self::Rx>

Clones the Self::Rx value, or takes it from the option if this endpoint is not cloneable. The Tx endpoint is also available, which is necessary to implement Channel for broadcast channels (where new receivers are created from a tx subscription call)

impl<T> Clone for Sender<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 Sender<T>

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

Formats the value using the given formatter.

impl<T> Sender<Subscription<T>> for Sender<T> where
    T: Debug + Send + Sync, 

fn send<'life0, 'async_trait>(
    &'life0 mut self,
    value: Subscription<T>
) -> Pin<Box<dyn Future<Output = Result<(), LifelineSendError<Subscription<T>>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

impl<T: Send + 'static> Storage for Sender<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