mirror/async-std
2
0
Fork 1
mirror of https://github.com/async-rs/async-std.git synced 2025-01-16 02:39:55 +00:00
Code Issues Releases Wiki Activity

Merge pull request #833 from OSSystems/topic/fix_channel_doc

Browse source 
channel doc: Fix misleading reference to None return on Receiver
This commit is contained in:
Yoshua Wuyts 2020-07-14 10:40:40 +02:00 committed by GitHub
commit 8aa5921dfa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/sync/channel.rs
View file

@ -22,8 +22,8 @@ use crate::sync::WakerSet;
/// This channel has a buffer that can hold at most `cap` messages at a time.
///
/// Senders and receivers can be cloned. When all senders associated with a channel get dropped, it
/// becomes closed. Receive operations on a closed and empty channel return `None` instead of
/// trying to await a message.
/// becomes closed. Receive operations on a closed and empty channel return [RecvError] instead of
/// trying to await a message when using [Receiver::recv] or `None` when used as a [Stream].
///
/// # Panics
///
@ -376,7 +376,7 @@ impl<T> Receiver<T> {
///
/// If the channel is empty 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`.
/// have been dropped it will return [RecvError].
///
/// # Examples
///