Struct heph_inbox::Sender

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

Sending side of the channel.

Implementations

impl<T> Sender<T>

pub fn try_send(&self, value: T) -> Result<(), SendError<T>>

Attempts to send the value into the channel.

pub fn send<'s>(&'s self, value: T) -> SendValue<'s, T>

Returns a future that sends a value into the channel, waiting if the channel is full.

If the returned Future returns an error it means the Receiver and Manager are disconnected and no more values will be read from the channel. This is the same error as SendError::Disconnected. SendError::Full will never be returned, the Future will return Poll::Pending instead.

pub fn capacity(&self) -> usize

Returns the capacity of the channel.

pub fn is_connected(&self) -> bool

Returns true if the Receiver and or the Manager are connected.

Notes

Unlike Receiver::is_connected this method takes the Manager into account. This is done to support the use case in which an actor is restarted and a new receiver is created for it.

pub fn has_manager(&self) -> bool

Returns true if the Manager is connected.

pub fn same_channel(&self, other: &Sender<T>) -> bool

Returns true if senders send into the same channel.

pub fn sends_to(&self, receiver: &Receiver<T>) -> bool

Returns true if this sender sends to the receiver.

pub fn id(&self) -> Id

Returns the id of this sender.

Trait Implementations

impl<T> Clone for Sender<T>

Safety

Only 2 ^ 30 (a billion) Senders may be alive concurrently, more then enough for all practical use cases.

fn clone(&self) -> Sender<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Sender<T>

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

Formats the value using the given formatter.

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send> Send for Sender<T>

impl<T> Sync for Sender<T>

impl<T> Unpin for Sender<T>