Struct remoc::rch::watch::Receiver

pub struct Receiver<T, Codec = Default, const MAX_ITEM_SIZE: usize = DEFAULT_MAX_ITEM_SIZE> { /* private fields */ }

Available on crate feature rch only.

Receive values from the associated Sender, which may be located on a remote endpoint.

Instances are created by the channel function.

This can be converted into a Stream of values by wrapping it into a ReceiverStream.

Implementations

impl<T, Codec, const MAX_ITEM_SIZE: usize> Receiver<T, Codec, MAX_ITEM_SIZE>

pub fn borrow(&self) -> Result<Ref<'_, T>, RecvError>

Returns a reference to the most recently received value.

pub fn borrow_and_update(&mut self) -> Result<Ref<'_, T>, RecvError>

Returns a reference to the most recently received value and mark that value as seen.

pub async fn changed(&mut self) -> Result<(), ChangedError>

Wait for a change notification, then mark the newest value as seen.

pub fn max_item_size(&self) -> usize

Maximum allowed item size in bytes when receiving items.

pub fn set_max_item_size<const NEW_MAX_ITEM_SIZE: usize>( self ) -> Receiver<T, Codec, NEW_MAX_ITEM_SIZE>

Sets the maximum allowed item size in bytes when receiving items.

pub fn remote_max_item_size(&self) -> Option<usize>

The maximum item size of the remote sender.

If this is larger than max_item_size sending of oversized items will succeed but receiving will fail with a MaxItemSizeExceeded error.

Trait Implementations

impl<T: Clone, Codec: Clone, const MAX_ITEM_SIZE: usize> Clone for Receiver<T, Codec, MAX_ITEM_SIZE>

fn clone(&self) -> Receiver<T, Codec, MAX_ITEM_SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, Codec, const MAX_ITEM_SIZE: usize> Debug for Receiver<T, Codec, MAX_ITEM_SIZE>

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

Formats the value using the given formatter.

impl<'de, T, Codec, const MAX_ITEM_SIZE: usize> Deserialize<'de> for Receiver<T, Codec, MAX_ITEM_SIZE>

where T: RemoteSend + Sync, Codec: Codec,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserializes the receiver after it has been received over a chmux channel.

impl<T, Codec, const MAX_ITEM_SIZE: usize> Drop for Receiver<T, Codec, MAX_ITEM_SIZE>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, Codec, const MAX_ITEM_SIZE: usize> From<Receiver<T, Codec, MAX_ITEM_SIZE>> for ReceiverStream<T, Codec, MAX_ITEM_SIZE>

where T: RemoteSend + Sync, Codec: Send + 'static,

fn from(recv: Receiver<T, Codec, MAX_ITEM_SIZE>) -> Self

Converts to this type from the input type.

impl<T, Codec, const MAX_ITEM_SIZE: usize> Serialize for Receiver<T, Codec, MAX_ITEM_SIZE>

where T: RemoteSend + Sync + Clone, Codec: Codec,

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

where S: Serializer,

Serializes this receiver for sending over a chmux channel.