[][src]Struct async_std::sync::Sender

pub struct Sender<T> { /* fields omitted */ }
This is supported on unstable only.

The sending side of a channel.

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);

Methods

impl<T> Sender<T>[src]

pub async fn send<'_>(&'_ self, msg: T)[src]

This is supported on unstable only.

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[src]

This is supported on unstable only.

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[src]

This is supported on unstable only.

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[src]

This is supported on unstable only.

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[src]

This is supported on unstable only.

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> Drop for Sender<T>[src]

impl<T> Clone for Sender<T>[src]

impl<T> Debug for Sender<T>[src]

Auto Trait Implementations

impl<T> Send for Sender<T> where
    T: Send

impl<T> Sync for Sender<T> where
    T: Send

impl<T> Unpin for Sender<T>

impl<T> !UnwindSafe for Sender<T>

impl<T> !RefUnwindSafe for Sender<T>

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]