eater/async-std
1
0
Fork 0
forked from mirror/async-std
Code Issues Pull requests Releases Wiki Activity

Merge pull request #703 from spacekookie/recv-docs

Browse source 
channel/recv: improving function docs and code example
This commit is contained in:
Yoshua Wuyts 2020-03-15 14:41:07 +01:00 committed by GitHub
commit e026b7579a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/sync/channel.rs
View file

@ -346,8 +346,9 @@ pub struct Receiver<T> {
impl<T> Receiver<T> {
/// Receives a message from the channel.
///
/// If the channel is empty and still has senders, this method will wait until a message is
/// sent into the channel or until all senders get dropped.
/// If the channel is emtpy and still has senders, this method
/// will wait until a message is sent into it. Once all senders
/// have been dropped it will return `None`.
///
/// # Examples
///
@ -362,10 +363,13 @@ impl<T> Receiver<T> {
/// task::spawn(async move {
/// s.send(1).await;
/// s.send(2).await;
/// // Then we drop the sender
/// });
///
/// assert_eq!(r.recv().await, Some(1));
/// assert_eq!(r.recv().await, Some(2));
///
/// // recv() returns `None`
/// assert_eq!(r.recv().await, None);
/// #
/// # })