mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-01-24 23:16:48 +00:00
docs: fix broken links of select! (#7860)
Co-authored-by: Martin Grigorov <martin-g@users.noreply.github.com>
This commit is contained in:
@@ -579,9 +579,11 @@ where
|
||||
/// # Cancel safety
|
||||
///
|
||||
/// This method is cancel safe. If `next_many` is used as the event in a
|
||||
/// [`tokio::select!`](tokio::select) statement and some other branch
|
||||
/// completes first, it is guaranteed that no items were received on any of
|
||||
/// the underlying streams.
|
||||
/// [`tokio::select!`] statement and some other branch completes first,
|
||||
/// it is guaranteed that no items were received on any of the underlying
|
||||
/// streams.
|
||||
///
|
||||
/// [`tokio::select!`]: https://docs.rs/tokio/latest/tokio/macro.select.html
|
||||
pub async fn next_many(&mut self, buffer: &mut Vec<(K, V::Item)>, limit: usize) -> usize {
|
||||
poll_fn(|cx| self.poll_next_many(cx, buffer, limit)).await
|
||||
}
|
||||
|
||||
@@ -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>>,
|
||||
|
||||
Reference in New Issue
Block a user