Struct remoc::chmux::Receiver

pub struct Receiver { /* private fields */ }

Receives byte data over a channel.

Implementations

impl Receiver

pub fn local_port(&self) -> u32

The local port number.

pub fn remote_port(&self) -> u32

The remote port number.

pub fn max_data_size(&self) -> usize

Maximum data size in bytes to receive per message.

The default value is specified by Cfg::max_data_size.

recv_chunk is not affected by this limit.

pub fn set_max_data_size(&mut self, max_data_size: usize)

Set maximum data size in bytes to receive per message.

recv_chunk is not affected by this limit.

pub fn max_ports(&self) -> usize

Maximum port count per message.

The default value is specified by Cfg::max_received_ports.

pub fn set_max_ports(&mut self, max_ports: usize)

Set maximum port count per message.

pub async fn recv(&mut self) -> Result<Option<DataBuf>, RecvError>

Receives data over the channel.

Waits for data to become available. Received port open requests are silently rejected. The size of the received data is limited by max_data_size.

pub async fn recv_chunk(&mut self) -> Result<Option<Bytes>, RecvChunkError>

Receives chunks of data over the channel.

This should be called when recv_any returns Received::Chunks to obtain the received data chunk by chunk. None is returned after the last chunk of a message.

This is unlimited in size.

pub async fn recv_any(&mut self) -> Result<Option<Received>, RecvError>

Receives data or ports over the channel.

pub async fn close(&mut self)

Closes the sender at the remote endpoint, preventing it from sending new data. Already sent message will still be received.

pub fn into_stream(self) -> ReceiverStream

👎Deprecated: use ReceiverStream::from instead

Convert this into a stream.

pub fn port_allocator(&self) -> PortAllocator

Returns the port allocator of the channel multiplexer.

pub fn storage(&self) -> AnyStorage

Returns the arbitrary data storage of the channel multiplexer.

Trait Implementations

impl Debug for Receiver

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

Formats the value using the given formatter.

impl Drop for Receiver

fn drop(&mut self)

Executes the destructor for this type.

impl From<Receiver> for ReceiverStream

fn from(recv: Receiver) -> Self

Converts to this type from the input type.