Struct ChannelBuilder

pub struct ChannelBuilder<'a, T> { /* private fields */ }

Builder type for creating channels.

Create a ChannelBuilder either with Handle::create_channel or ChannelBuilder::new.

The ChannelBuilder is used to specify which of the channels ends will be claimed by the local client.

Note that this type is Copy and is thus not consumed by any of its methods.

Implementations

impl<'a, T> ChannelBuilder<'a, T>

pub fn new(client: &'a Handle) -> Self

Creates a new ChannelBuilder.

Alternatively, Handle::create_channel can be more convenient to use, because it usually avoids the need to import ChannelBuilder.

// Option 1
let builder = ChannelBuilder::<String>::new(&handle);

// Option 2
let builder = handle.create_channel::<String>();

It’s not usually necessary to specify the item’s type explicitly, because it can be deferred by the compiler in many cases.

pub fn client(self) -> &'a Handle

Returns a Handle to the associated client.

pub fn cast<U>(self) -> ChannelBuilder<'a, U>

Casts the item type to a different type U.

pub async fn claim_sender( self, ) -> Result<(PendingSender<T>, UnclaimedReceiver<T>), Error>

Creates a new channel and claims the sender.

pub async fn claim_receiver( self, capacity: u32, ) -> Result<(UnclaimedSender<T>, PendingReceiver<T>), Error>

Creates a new channel and claims the receiver.

A capacity of 0 will be treated as if 1 was specified instead.

Trait Implementations

impl<T> Clone for ChannelBuilder<'_, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ChannelBuilder<'_, T>

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

Formats the value using the given formatter.

impl<T> Copy for ChannelBuilder<'_, T>