mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-15 00:00:15 +02:00
Fix doc links (#1799)
Link fix only. After this fix, `cargo doc --package` succeeds.
This commit is contained in:
+1
-1
@@ -6,7 +6,7 @@
|
||||
//!
|
||||
//! Tasks run by *worker* threads should not block, as this could delay
|
||||
//! servicing reactor events. Portable filesystem operations are blocking,
|
||||
//! however. This module offers adapters which use a [`blocking`] annotation
|
||||
//! however. This module offers adapters which use a `blocking` annotation
|
||||
//! to inform the runtime that a blocking operation is required. When
|
||||
//! necessary, this allows the runtime to convert the current thread from a
|
||||
//! *worker* to a *backup* thread, where blocking is acceptable.
|
||||
|
||||
@@ -36,7 +36,7 @@ pub async fn read_dir(path: impl AsRef<Path>) -> io::Result<ReadDir> {
|
||||
///
|
||||
/// [`read_dir`]: read_dir
|
||||
/// [`DirEntry`]: DirEntry
|
||||
/// [`Stream`]: Stream
|
||||
/// [`Stream`]: futures_core::Stream
|
||||
/// [`Err`]: std::result::Result::Err
|
||||
#[derive(Debug)]
|
||||
#[must_use = "streams do nothing unless polled"]
|
||||
|
||||
+2
-2
@@ -22,11 +22,11 @@
|
||||
//! IOCP, etc...).
|
||||
//! * Asynchronous [TCP and UDP][net] sockets.
|
||||
//! * Asynchronous [filesystem][fs] operations.
|
||||
//! * [Timer][timer] API for scheduling work in the future.
|
||||
//! * [Timer][time] API for scheduling work in the future.
|
||||
//!
|
||||
//! Guide level documentation is found on the [website].
|
||||
//!
|
||||
//! [driver]: tokio::net::driver
|
||||
//! [driver]: driver/index.html
|
||||
//! [website]: https://tokio.rs/docs/
|
||||
//!
|
||||
//! # Examples
|
||||
|
||||
@@ -304,7 +304,7 @@ impl TryFrom<TcpListener> for mio::net::TcpListener {
|
||||
/// See [`PollEvented::into_inner`] for more details about
|
||||
/// resource deregistration that happens during the call.
|
||||
///
|
||||
/// [`PollEvented::into_inner`]: crate::util::PollEvented::into_inner
|
||||
/// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner
|
||||
fn try_from(value: TcpListener) -> Result<Self, Self::Error> {
|
||||
value.io.into_inner()
|
||||
}
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
//! [`connect`] method, which returns a future which returns a `TcpStream`.
|
||||
//!
|
||||
//! To listen on an address [`TcpListener`] can be used. `TcpListener`'s
|
||||
//! [`incoming`][incoming_method] method can be used to accept new connections.
|
||||
//! [`incoming`][TcpListener::incoming] method can be used to accept new connections.
|
||||
//! It return the [`Incoming`] struct, which implements a stream which returns
|
||||
//! `TcpStream`s.
|
||||
//!
|
||||
|
||||
@@ -720,7 +720,7 @@ impl TryFrom<TcpStream> for mio::net::TcpStream {
|
||||
/// See [`PollEvented::into_inner`] for more details about
|
||||
/// resource deregistration that happens during the call.
|
||||
///
|
||||
/// [`PollEvented::into_inner`]: crate::util::PollEvented::into_inner
|
||||
/// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner
|
||||
fn try_from(value: TcpStream) -> Result<Self, Self::Error> {
|
||||
value.io.into_inner()
|
||||
}
|
||||
|
||||
@@ -367,7 +367,7 @@ impl TryFrom<UdpSocket> for mio::net::UdpSocket {
|
||||
/// See [`PollEvented::into_inner`] for more details about
|
||||
/// resource deregistration that happens during the call.
|
||||
///
|
||||
/// [`PollEvented::into_inner`]: crate::util::PollEvented::into_inner
|
||||
/// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner
|
||||
fn try_from(value: UdpSocket) -> Result<Self, Self::Error> {
|
||||
value.io.into_inner()
|
||||
}
|
||||
|
||||
@@ -201,7 +201,7 @@ impl TryFrom<UnixDatagram> for mio_uds::UnixDatagram {
|
||||
/// See [`PollEvented::into_inner`] for more details about
|
||||
/// resource deregistration that happens during the call.
|
||||
///
|
||||
/// [`PollEvented::into_inner`]: crate::util::PollEvented::into_inner
|
||||
/// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner
|
||||
fn try_from(value: UnixDatagram) -> Result<Self, Self::Error> {
|
||||
value.io.into_inner()
|
||||
}
|
||||
|
||||
@@ -102,7 +102,7 @@ impl TryFrom<UnixListener> for mio_uds::UnixListener {
|
||||
/// See [`PollEvented::into_inner`] for more details about
|
||||
/// resource deregistration that happens during the call.
|
||||
///
|
||||
/// [`PollEvented::into_inner`]: crate::util::PollEvented::into_inner
|
||||
/// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner
|
||||
fn try_from(value: UnixListener) -> Result<Self, Self::Error> {
|
||||
value.io.into_inner()
|
||||
}
|
||||
|
||||
@@ -118,7 +118,7 @@ impl TryFrom<UnixStream> for mio_uds::UnixStream {
|
||||
/// See [`PollEvented::into_inner`] for more details about
|
||||
/// resource deregistration that happens during the call.
|
||||
///
|
||||
/// [`PollEvented::into_inner`]: crate::util::PollEvented::into_inner
|
||||
/// [`PollEvented::into_inner`]: crate::io::PollEvented::into_inner
|
||||
fn try_from(value: UnixStream) -> Result<Self, Self::Error> {
|
||||
value.io.into_inner()
|
||||
}
|
||||
|
||||
@@ -101,7 +101,7 @@
|
||||
//! While similar to the standard library, this crate's `Child` type differs
|
||||
//! importantly in the behavior of `drop`. In the standard library, a child
|
||||
//! process will continue running after the instance of [`std::process::Child`]
|
||||
//! is dropped. In this crate, however, because [`tokio::process::Child`] is a
|
||||
//! is dropped. In this crate, however, because [`tokio::process::Child`][Child] is a
|
||||
//! future of the child's `ExitStatus`, a child process is terminated if
|
||||
//! `tokio::process::Child` is dropped. The behavior of the standard library can
|
||||
//! be regained with the [`Child::forget`](crate::process::Child::forget) method.
|
||||
|
||||
@@ -119,7 +119,7 @@
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! [driver]: tokio::net::driver
|
||||
//! [driver]: crate::io::driver
|
||||
//! [executor]: https://tokio.rs/docs/internals/runtime-model/#executors
|
||||
//! [`Runtime`]: struct.Runtime.html
|
||||
//! [`Reactor`]: ../reactor/struct.Reactor.html
|
||||
|
||||
@@ -75,7 +75,7 @@ pub fn interval_at(start: Instant, period: Duration) -> Interval {
|
||||
}
|
||||
}
|
||||
|
||||
/// Stream returned by [`instant`](instant) and [`instant_at`](instant_at).
|
||||
/// Stream returned by [`interval`](interval) and [`interval_at`](interval_at).
|
||||
#[derive(Debug)]
|
||||
pub struct Interval {
|
||||
/// Future that completes the next time the `Interval` yields a value.
|
||||
|
||||
Reference in New Issue
Block a user