itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-09-28 12:10:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: remove reference to the Sink trait in the MPSC documentation (#2476)

Browse Source 
The implementation of the Sink trait was removed in 8a7e5778.

Fixes: #2464
Refs: #2389
This commit is contained in:
zeroed 2020-05-02 22:41:40 +02:00 committed by GitHub
parent 20b5df9037
commit 31315b9463
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tokio/src/sync/mpsc/mod.rs
View File

@ -6,10 +6,9 @@
//! Similar to `std`, channel creation provides [`Receiver`] and [`Sender`]
//! handles. [`Receiver`] implements `Stream` and allows a task to read values
//! out of the channel. If there is no message to read, the current task will be
//! notified when a new value is sent. [`Sender`] implements the `Sink` trait
//! and allows sending messages into the channel. If the channel is at capacity,
//! the send is rejected and the task will be notified when additional capacity
//! is available. In other words, the channel provides backpressure.
//! notified when a new value is sent. If the channel is at capacity, the send
//! is rejected and the task will be notified when additional capacity is
//! available. In other words, the channel provides backpressure.
//!
//! Unbounded channels are also available using the `unbounded_channel`
//! constructor.