Skip to content

Commit

Permalink
docs: add link to PollSender (#3613)
Browse files Browse the repository at this point in the history
There was no link to [`PollSender`] in [`mpsc::Sender`] docs which made it
less discoverable.

[`PollSender`]: https://docs.rs/tokio-util/0.6.4/tokio_util/sync/struct.PollSender.html
[`mpsc::Sender::send`]: https://docs.rs/tokio/1.3.0/tokio/sync/mpsc/struct.Sender.html
  • Loading branch information
zaharidichev authored Mar 16, 2021
1 parent cc90a5c commit e6103d6
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions tokio/src/sync/mpsc/bounded.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ use std::task::{Context, Poll};
/// Send values to the associated `Receiver`.
///
/// Instances are created by the [`channel`](channel) function.
///
/// To use the `Sender` in a poll function, you can use the [`PollSender`]
/// utility.
///
/// [`PollSender`]: https://docs.rs/tokio-util/0.6/tokio_util/sync/struct.PollSender.html
pub struct Sender<T> {
chan: chan::Tx<T, Semaphore>,
}
Expand Down

0 comments on commit e6103d6

Please sign in to comment.