tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-09-07 00:00:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

sync: update Sender::try_reserve doc (#3476)

Browse Source
This commit is contained in:
vitalyd
2021-01-28 10:31:23 +01:00
committed by GitHub
parent 34f1d3d040
commit 4968f59af6
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/sync/mpsc/bounded.rs
+4 -3
View File
@@ -22,10 +22,11 @@ pub struct Sender<T> {
/// Permit to send one value into the channel. /// Permit to send one value into the channel.
/// ///
/// `Permit` values are returned by [`Sender::reserve()`] and are used to /// `Permit` values are returned by [`Sender::reserve()`] and [`Sender::try_reserve()`]
/// guarantee channel capacity before generating a message to send. /// and are used to guarantee channel capacity before generating a message to send.
/// ///
/// [`Sender::reserve()`]: Sender::reserve /// [`Sender::reserve()`]: Sender::reserve
/// [`Sender::try_reserve()`]: Sender::try_reserve
pub struct Permit<'a, T> { pub struct Permit<'a, T> {
chan: &'a chan::Tx<T, Semaphore>, chan: &'a chan::Tx<T, Semaphore>,
} }
@@ -652,7 +653,7 @@ impl<T> Sender<T> {
/// If the channel is full this function will return [`TrySendError`], otherwise /// If the channel is full this function will return [`TrySendError`], otherwise
/// if there is a slot available it will return a [`Permit`] that will then allow you /// if there is a slot available it will return a [`Permit`] that will then allow you
/// to [`send`] on the channel with a guaranteed slot. This function is similar to /// to [`send`] on the channel with a guaranteed slot. This function is similar to
/// [`reserve`] execpt it does not await for the slot to become available. /// [`reserve`] except it does not await for the slot to become available.
/// ///
/// Dropping [`Permit`] without sending a message releases the capacity back /// Dropping [`Permit`] without sending a message releases the capacity back
/// to the channel. /// to the channel.