Skip to content

Commit

Permalink
sync: add link to PollSemaphore (#3456)
Browse files Browse the repository at this point in the history
  • Loading branch information
Darksonn authored Jan 21, 2021
1 parent f2a048d commit 29bd5fa
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions tokio/src/sync/semaphore.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ use std::sync::Arc;
/// function immediately returns a permit. However, if no remaining permits are
/// available, `acquire` (asynchronously) waits until an outstanding permit is
/// dropped. At this point, the freed permit is assigned to the caller.
///
/// To use the `Semaphore` in a poll function, you can use the [`PollSemaphore`]
/// utility.
///
/// [`PollSemaphore`]: https://docs.rs/tokio-util/0.6/tokio_util/sync/struct.PollSemaphore.html
#[derive(Debug)]
pub struct Semaphore {
/// The low level semaphore
Expand Down

0 comments on commit 29bd5fa

Please sign in to comment.