Struct aldrin::PendingSender

pub struct PendingSender<T: Serialize + ?Sized> { /* private fields */ }

A claimed sender that is waiting for the channel to become established.

PendingSenders are used to wait until some client has claimed the receiving end of the channel. This is done with the established function.

Implementations

impl<T: Serialize + ?Sized> PendingSender<T>

pub async fn close(&mut self) -> Result<(), Error>

Closes the sender without consuming it.

When closing a PendingSender, it will no longer be possible to claim the receiver. If it has already been claimed, then it will receive None, indicating that the channel has been closed.

Examples

Closing a sender while the receiver hasn’t been claimed yet

use aldrin::Error;

let (mut sender, receiver) = handle.create_channel_with_claimed_sender::<u32>().await?;

// Close the sender.
sender.close().await?;

// For the receiver, an error will be returned when trying to claim it.
let err = receiver.claim(16).await.unwrap_err();
assert_eq!(err, Error::InvalidChannel);

Closing a sender while the receiver has already been claimed

use aldrin::Error;

let (mut sender, receiver) = handle.create_channel_with_claimed_sender::<u32>().await?;

// Claim the receiver.
let mut receiver = receiver.claim(16).await?;

// Close the sender.
sender.close().await?;

// The receiver will receive None.
assert_eq!(receiver.next_item().await, Ok(None));

pub async fn established(self) -> Result<Sender<T>, Error>

Waits until the channel has been established.

A channel is established when both ends have been claimed. An error is returned when the receiver has been closed instead of claimed.

pub fn cast<U: Serialize + ?Sized>(self) -> PendingSender<U>

Casts the item type to a different type.

Trait Implementations

impl<T: Debug + Serialize + ?Sized> Debug for PendingSender<T>

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

Formats the value using the given formatter.