Struct async_std::sync::Sender [−][src]
👎 Deprecated:
new channel api at async_std::channel
The sending side of a channel.
This struct is created by the channel
function. See its
documentation for more.
Examples
#![allow(deprecated)] 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>
[src][−]
pub async fn send(&self, msg: T)
[src][−]
Sends a message into the channel.
If the channel is full, this method will wait until there is space in the channel.
Examples
#![allow(deprecated)] 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?, 1); assert_eq!(r.recv().await?, 2); assert!(r.recv().await.is_err());
pub fn try_send(&self, msg: T) -> Result<(), TrySendError<T>>
[src][−]
Attempts to send a message into the channel.
If the channel is full, this method will return an error.
Examples
#![allow(deprecated)] use async_std::sync::channel; let (s, r) = channel(1); assert!(s.try_send(1).is_ok()); assert!(s.try_send(2).is_err());
pub fn capacity(&self) -> usize
[src][−]
Returns the channel capacity.
Examples
#![allow(deprecated)] use async_std::sync::channel; let (s, _) = channel::<i32>(5); assert_eq!(s.capacity(), 5);
pub fn is_empty(&self) -> bool
[src][−]
Returns true
if the channel is empty.
Examples
#![allow(deprecated)] 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][−]
Returns true
if the channel is full.
Examples
#![allow(deprecated)] 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][−]
Returns the number of messages in the channel.
Examples
#![allow(deprecated)] 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>
[src][+]
impl<T> Debug for Sender<T>
[src][+]
impl<T> Drop for Sender<T>
[src][+]
Auto Trait Implementations
impl<T> !RefUnwindSafe for Sender<T>
impl<T> Send for Sender<T> where
T: Send,
T: Send,
impl<T> Sync for Sender<T> where
T: Send,
T: Send,
impl<T> Unpin for Sender<T>
impl<T> !UnwindSafe for Sender<T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src][+]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src][+]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src][+]
T: ?Sized,
impl<T> From<T> for T
[src][+]
impl<T, U> Into<U> for T where
U: From<T>,
[src][+]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src][+]
T: Clone,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src][+]
U: Into<T>,
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src][+]
U: TryFrom<T>,