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

docs: fix broken links of select! (#7860)

Browse Source 
Co-authored-by: Martin Grigorov <[email protected]>
This commit is contained in:
Mattia Pitossi
2026-01-17 10:10:59 -08:00
committed by GitHub
co-authored by Martin Grigorov
parent 27d1383581
commit bf185b61ff
2 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-util/src/io/simplex.rs
+8 -5
View File
@@ -88,13 +88,15 @@ impl Inner {
/// # Cancellation safety
///
/// The `Receiver` is cancel safe. If it is used as the event in a
/// [`tokio::select!`](macro@tokio::select) statement and some other branch
/// completes first, it is guaranteed that no bytes were received on this
/// [`tokio::select!`] statement and some other branch completes
/// first, it is guaranteed that no bytes were received on this
/// channel.
///
/// You can still read the remaining data from the buffer
/// even if the write half has been dropped.
/// See [`Sender::poll_shutdown`] and [`Sender::drop`] for more details.
///
/// [`tokio::select!`]: https://docs.rs/tokio/latest/tokio/macro.select.html
#[derive(Debug)]
pub struct Receiver {
inner: Arc<Mutex<Inner>>,
@@ -163,13 +165,14 @@ impl AsyncRead for Receiver {
/// # Cancellation safety
///
/// The `Sender` is cancel safe. If it is used as the event in a
/// [`tokio::select!`](macro@tokio::select) statement and some other branch
/// completes first, it is guaranteed that no bytes were sent on this
/// channel.
/// [`tokio::select!`] statement and some other branch completes
/// first, it is guaranteed that no bytes were sent on this channel.
///
/// # Shutdown
///
/// See [`Sender::poll_shutdown`].
///
/// [`tokio::select!`]: https://docs.rs/tokio/latest/tokio/macro.select.html
#[derive(Debug)]
pub struct Sender {
inner: Arc<Mutex<Inner>>,