Struct Sender

pub struct Sender<T> { /* private fields */ }

Available on unstable only.

The sending side of a channel.

This struct is created by the channel function. See its documentation for more.

Examples

use async_std::sync::channel;
use async_std::task;

let (s1, r) = channel(100);
let s2 = s1.clone();

task::spawn(async move { s1.send(1).await });
task::spawn(async move { s2.send(2).await });

let msg1 = r.recv().await.unwrap();
let msg2 = r.recv().await.unwrap();

assert_eq!(msg1 + msg2, 3);

Implementations

impl<T> Sender<T>

pub async fn send(&self, msg: T)

Sends a message into the channel.

If the channel is full, this method will wait until there is space in the channel.

Examples

use async_std::sync::channel;
use async_std::task;

let (s, r) = channel(1);

task::spawn(async move {
    s.send(1).await;
    s.send(2).await;
});

assert_eq!(r.recv().await, Some(1));
assert_eq!(r.recv().await, Some(2));
assert_eq!(r.recv().await, None);

pub fn capacity(&self) -> usize

Returns the channel capacity.

Examples

use async_std::sync::channel;

let (s, _) = channel::<i32>(5);
assert_eq!(s.capacity(), 5);

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

Examples

use async_std::sync::channel;

let (s, r) = channel(1);

assert!(s.is_empty());
s.send(0).await;
assert!(!s.is_empty());

pub fn is_full(&self) -> bool

Returns true if the channel is full.

Examples

use async_std::sync::channel;

let (s, r) = channel(1);

assert!(!s.is_full());
s.send(0).await;
assert!(s.is_full());

pub fn len(&self) -> usize

Returns the number of messages in the channel.

Examples

use async_std::sync::channel;

let (s, r) = channel(2);
assert_eq!(s.len(), 0);

s.send(1).await;
s.send(2).await;
assert_eq!(s.len(), 2);

Trait Implementations

impl<T> Clone for Sender<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Sender<T>

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

Formats the value using the given formatter.

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.