diff options
| author | fkjogu <fkjogu@users.noreply.github.com> | 2016-11-24 09:49:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-24 09:49:30 +0100 |
| commit | a3e03e42e1298b49b647c8f80050421458414385 (patch) | |
| tree | 048440611be48b1d3c5caf40e23c89f84319f6c5 /src/libstd/sync | |
| parent | 696fab844aef55eb4bcbeb470c01ce7d301c51ed (diff) | |
| download | rust-a3e03e42e1298b49b647c8f80050421458414385.tar.gz rust-a3e03e42e1298b49b647c8f80050421458414385.zip | |
Define `bound` argument in std::sync::mpsc::sync_channel
The `bound` argument in `std::sync::mpsc::sync:channel(bound: usize)` was not defined in the documentation.
Diffstat (limited to 'src/libstd/sync')
| -rw-r--r-- | src/libstd/sync/mpsc/mod.rs | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/libstd/sync/mpsc/mod.rs b/src/libstd/sync/mpsc/mod.rs index 2773629c7d7..ca6e46eb15a 100644 --- a/src/libstd/sync/mpsc/mod.rs +++ b/src/libstd/sync/mpsc/mod.rs @@ -491,11 +491,11 @@ pub fn channel<T>() -> (Sender<T>, Receiver<T>) { /// becomes available. These channels differ greatly in the semantics of the /// sender from asynchronous channels, however. /// -/// This channel has an internal buffer on which messages will be queued. When -/// the internal buffer becomes full, future sends will *block* waiting for the -/// buffer to open up. Note that a buffer size of 0 is valid, in which case this -/// becomes "rendezvous channel" where each send will not return until a recv -/// is paired with it. +/// This channel has an internal buffer on which messages will be queued. `bound` +/// specifies the buffer size. When the internal buffer becomes full, future sends +/// will *block* waiting for the buffer to open up. Note that a buffer size of 0 +/// is valid, in which case this becomes "rendezvous channel" where each send will +/// not return until a recv is paired with it. /// /// As with asynchronous channels, all senders will panic in `send` if the /// `Receiver` has been destroyed. |
