Struct Sender 

pub struct Sender<T, Codec = Json, const BUFFER: usize = remoc::::rch::mpsc::sender::Sender::{constant#0}> { /* private fields */ }

Send values to the associated Receiver, which may be located on a remote endpoint.

Instances are created by the channel function.

Implementations

impl<T, Codec, const BUFFER: usize> Sender<T, Codec, BUFFER>

where T: Send + 'static,

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

Sends a value over this channel.

Error reporting

Sending and error reporting are done asynchronously. Thus, the reporting of an error may be delayed and this function may return errors caused by previous invocations.

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

Attempts to immediately send a message over this channel.

Error reporting

Sending and error reporting are done asynchronously. Thus, the reporting of an error may be delayed and this function may return errors caused by previous invocations.

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

Blocking send to call outside of asynchronous contexts.

Error reporting

Sending and error reporting are done asynchronously. Thus, the reporting of an error may be delayed and this function may return errors caused by previous invocations.

Panics

This function panics if called within an asynchronous execution context.

pub async fn reserve(&self) -> Result<Permit<T>, SendError<()>>

Wait for channel capacity, returning an owned permit. Once capacity to send one message is available, it is reserved for the caller.

Error reporting

Sending and error reporting are done asynchronously. Thus, the reporting of an error may be delayed and this function may return errors caused by previous invocations.

pub fn capacity(&self) -> usize

Returns the current capacity of the channel.

Zero is returned when the channel has been closed or an error has occurred.

pub async fn closed(&self)

Completes when the receiver has been closed, dropped or the connection failed.

Use closed_reason to obtain the cause for closure.

pub fn closed_reason(&self) -> Option<ClosedReason>

Returns the reason for why the channel has been closed.

Returns None if the channel is not closed.

pub fn is_closed(&self) -> bool

Returns whether the receiver has been closed, dropped or the connection failed.

Use closed_reason to obtain the cause for closure.

pub fn set_codec<NewCodec>(self) -> Sender<T, NewCodec, BUFFER>

Sets the codec that will be used when sending this sender to a remote endpoint.

pub fn set_buffer<const NEW_BUFFER: usize>(self) -> Sender<T, Codec, NEW_BUFFER>

Sets the buffer size that will be used when sending this sender to a remote endpoint.

pub fn max_item_size(&self) -> usize

The maximum allowed item size in bytes.

pub fn set_max_item_size(&mut self, max_item_size: usize)

Sets the maximum allowed item size in bytes.

Trait Implementations

impl<T, Codec, const BUFFER: usize> Clone for Sender<T, Codec, BUFFER>

fn clone(&self) -> Sender<T, Codec, BUFFER>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, Codec, const BUFFER: usize> Debug for Sender<T, Codec, BUFFER>

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

Formats the value using the given formatter.

impl<'de, T, Codec, const BUFFER: usize> Deserialize<'de> for Sender<T, Codec, BUFFER>

where T: RemoteSend, Codec: Codec,

fn deserialize<D>( deserializer: D, ) -> Result<Sender<T, Codec, BUFFER>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes this sender after it has been received over a chmux channel.

impl<T, Codec, const BUFFER: usize> Drop for Sender<T, Codec, BUFFER>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, Codec, const BUFFER: usize> Serialize for Sender<T, Codec, BUFFER>

where T: RemoteSend, Codec: Codec,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes this sender for sending over a chmux channel.