Struct aldrin::UnboundReceiver

pub struct UnboundReceiver<T: Deserialize> { /* private fields */ }

A receiver that is not bound to any particular client.

UnboundReceivers are used to transfer receivers to some other client, typically by returning them from function calls.

When creating a channel the resulting UnclaimedReceiver can be unbound and sent to another client.

It is worth noting that this type implements Copy and Clone. As such (and because it is not bound to any client), it will not close the receiving end of a channel. This is the main difference from UnclaimedReceiver.

Implementations

impl<T: Deserialize> UnboundReceiver<T>

pub fn bind(self, client: Handle) -> UnclaimedReceiver<T>

Binds the receiver to a client.

See also claim to bind and claim the receiver in one step.

Examples

use aldrin::{Receiver, UnclaimedReceiver};

// Assume this receiver has been returned from some function call.
// let receiver: UnboundReceiver<u32> = ...

// Bind it to the local client. The explicit type is shown here only for the sake of the
// example.
let receiver: UnclaimedReceiver<u32> = receiver.bind(handle.clone());

// Afterwards, it can be claimed.
let receiver: Receiver<u32> = receiver.claim(16).await?;

pub async fn claim( self, client: Handle, capacity: u32 ) -> Result<Receiver<T>, Error>

Binds the receiver to a client and claims it.

This function is equivalent to receiver.bind(client).claim().

See UnclaimedReceiver::claim for explanation of the cases in which this function can fail.

A capacity of 0 is treated as if 1 was specificed instead.

Examples

use aldrin::Receiver;

// Assume this receiver has been returned from some function call.
// let receiver: UnboundReceiver<u32> = ...

// Bind it to the local client and claim it, so that it can immediately be used. The
// explicit type here is given only for the sake of the example.
let receiver: Receiver<u32> = receiver.claim(handle.clone(), 16).await?;

pub fn cast<U: Deserialize>(self) -> UnboundReceiver<U>

Casts the item type to a different type.

Trait Implementations

impl<T: Clone + Deserialize> Clone for UnboundReceiver<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Deserialize> Debug for UnboundReceiver<T>

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

Formats the value using the given formatter.

impl<T: Deserialize> Deserialize for UnboundReceiver<T>

fn deserialize( deserializer: Deserializer<'_, '_> ) -> Result<Self, DeserializeError>

impl<T: PartialEq + Deserialize> PartialEq for UnboundReceiver<T>

fn eq(&self, other: &UnboundReceiver<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Deserialize> Serialize for UnboundReceiver<T>

fn serialize(&self, serializer: Serializer<'_>) -> Result<(), SerializeError>

impl<T: Copy + Deserialize> Copy for UnboundReceiver<T>

impl<T: Eq + Deserialize> Eq for UnboundReceiver<T>

impl<T: Deserialize> StructuralPartialEq for UnboundReceiver<T>