mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-27 00:00:12 +02:00
chore: fix docs links (#1523)
This commit is contained in:
committed by
Carl Lerche
parent
6369d0f4f2
commit
c0a64d67ca
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Asynchronous stream of bytes.
|
//! Asynchronous stream of bytes.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Utilities for encoding and decoding frames.
|
//! Utilities for encoding and decoding frames.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Task execution related traits and utilities.
|
//! Task execution related traits and utilities.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Asynchronous file and standard stream adaptation.
|
//! Asynchronous file and standard stream adaptation.
|
||||||
|
|||||||
@@ -16,9 +16,7 @@ use std::task::Poll;
|
|||||||
|
|
||||||
/// Returns a stream over the entries within a directory.
|
/// Returns a stream over the entries within a directory.
|
||||||
///
|
///
|
||||||
/// This is an async version of [`std::fs::read_dir`][std]
|
/// This is an async version of [`std::fs::read_dir`](std::fs::read_dir)
|
||||||
///
|
|
||||||
/// [std]: https://doc.rust-lang.org/std/fs/fn.read_dir.html
|
|
||||||
pub async fn read_dir<P>(path: P) -> io::Result<ReadDir>
|
pub async fn read_dir<P>(path: P) -> io::Result<ReadDir>
|
||||||
where
|
where
|
||||||
P: AsRef<Path> + Send + 'static,
|
P: AsRef<Path> + Send + 'static,
|
||||||
@@ -43,8 +41,8 @@ where
|
|||||||
///
|
///
|
||||||
/// [`read_dir`]: fn.read_dir.html
|
/// [`read_dir`]: fn.read_dir.html
|
||||||
/// [`DirEntry`]: struct.DirEntry.html
|
/// [`DirEntry`]: struct.DirEntry.html
|
||||||
/// [`Stream`]: ../futures/stream/trait.Stream.html
|
/// [`Stream`]: Stream
|
||||||
/// [`Err`]: https://doc.rust-lang.org/std/result/enum.Result.html#variant.Err
|
/// [`Err`]: std::result::Result::Err
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
#[must_use = "streams do nothing unless polled"]
|
#[must_use = "streams do nothing unless polled"]
|
||||||
pub struct ReadDir(State);
|
pub struct ReadDir(State);
|
||||||
@@ -86,14 +84,12 @@ impl Stream for ReadDir {
|
|||||||
///
|
///
|
||||||
/// [`ReadDir`]: struct.ReadDir.html
|
/// [`ReadDir`]: struct.ReadDir.html
|
||||||
///
|
///
|
||||||
/// This is a specialized version of [`std::fs::DirEntry`][std] for usage from the
|
/// This is a specialized version of [`std::fs::DirEntry`](std::fs::DirEntry) for usage from the
|
||||||
/// Tokio runtime.
|
/// Tokio runtime.
|
||||||
///
|
///
|
||||||
/// An instance of `DirEntry` represents an entry inside of a directory on the
|
/// An instance of `DirEntry` represents an entry inside of a directory on the
|
||||||
/// filesystem. Each entry can be inspected via methods to learn about the full
|
/// filesystem. Each entry can be inspected via methods to learn about the full
|
||||||
/// path or possibly other metadata through per-platform extension traits.
|
/// path or possibly other metadata through per-platform extension traits.
|
||||||
///
|
|
||||||
/// [std]: https://doc.rust-lang.org/std/fs/struct.DirEntry.html
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub struct DirEntry(Arc<std::fs::DirEntry>);
|
pub struct DirEntry(Arc<std::fs::DirEntry>);
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ use std::path::{Path, PathBuf};
|
|||||||
///
|
///
|
||||||
/// This is an async version of [`std::fs::read_link`][std]
|
/// This is an async version of [`std::fs::read_link`][std]
|
||||||
///
|
///
|
||||||
/// [std]: https://doc.rust-lang.org/std/fs/fn.read_link.html
|
/// [std]: std::fs::read_link
|
||||||
pub async fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
|
pub async fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
|
||||||
let path = path.as_ref().to_owned();
|
let path = path.as_ref().to_owned();
|
||||||
asyncify(move || std::fs::read_link(path)).await
|
asyncify(move || std::fs::read_link(path)).await
|
||||||
|
|||||||
@@ -5,9 +5,7 @@ use std::path::Path;
|
|||||||
|
|
||||||
/// Removes an existing, empty directory.
|
/// Removes an existing, empty directory.
|
||||||
///
|
///
|
||||||
/// This is an async version of [`std::fs::remove_dir`][std]
|
/// This is an async version of [`std::fs::remove_dir`](std::fs::remove_dir)
|
||||||
///
|
|
||||||
/// [std]: https://doc.rust-lang.org/std/fs/fn.remove_dir.html
|
|
||||||
pub async fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
|
pub async fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
|
||||||
let path = path.as_ref().to_owned();
|
let path = path.as_ref().to_owned();
|
||||||
asyncify(move || std::fs::remove_dir(path)).await
|
asyncify(move || std::fs::remove_dir(path)).await
|
||||||
|
|||||||
@@ -8,9 +8,7 @@ use std::path::Path;
|
|||||||
///
|
///
|
||||||
/// This will not work if the new name is on a different mount point.
|
/// This will not work if the new name is on a different mount point.
|
||||||
///
|
///
|
||||||
/// This is an async version of [`std::fs::rename`][std]
|
/// This is an async version of [`std::fs::rename`](std::fs::rename)
|
||||||
///
|
|
||||||
/// [std]: https://doc.rust-lang.org/std/fs/fn.rename.html
|
|
||||||
pub async fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
|
pub async fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
|
||||||
let from = from.as_ref().to_owned();
|
let from = from.as_ref().to_owned();
|
||||||
let to = to.as_ref().to_owned();
|
let to = to.as_ref().to_owned();
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Core I/O traits and combinators when working with Tokio.
|
//! Core I/O traits and combinators when working with Tokio.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Macros for use with Tokio
|
//! Macros for use with Tokio
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Event loop that drives Tokio I/O resources.
|
//! Event loop that drives Tokio I/O resources.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
//! An implementation of asynchronous process management for Tokio.
|
//! An implementation of asynchronous process management for Tokio.
|
||||||
//!
|
//!
|
||||||
//! This module provides a [`Command`](Command) struct that imitates the interface of the
|
//! This module provides a [`Command`](crate::process::Command) struct that imitates the interface of the
|
||||||
//! [`std::process::Command`] type in the standard library, but provides asynchronous versions of
|
//! [`std::process::Command`] type in the standard library, but provides asynchronous versions of
|
||||||
//! functions that create processes. These functions (`spawn`, `status`, `output` and their
|
//! functions that create processes. These functions (`spawn`, `status`, `output` and their
|
||||||
//! variants) return "future aware" types that interoperate with Tokio. The asynchronous process
|
//! variants) return "future aware" types that interoperate with Tokio. The asynchronous process
|
||||||
@@ -101,10 +101,10 @@
|
|||||||
//! While similar to the standard library, this crate's `Child` type differs
|
//! While similar to the standard library, this crate's `Child` type differs
|
||||||
//! importantly in the behavior of `drop`. In the standard library, a child
|
//! importantly in the behavior of `drop`. In the standard library, a child
|
||||||
//! process will continue running after the instance of [`std::process::Child`]
|
//! process will continue running after the instance of [`std::process::Child`]
|
||||||
//! is dropped. In this crate, however, because [`tokio_net::process::Child`](Child) is a
|
//! is dropped. In this crate, however, because [`tokio_net::process::Child`](crate::process::Child) is a
|
||||||
//! future of the child's `ExitStatus`, a child process is terminated if
|
//! future of the child's `ExitStatus`, a child process is terminated if
|
||||||
//! `tokio_net::process::Child` is dropped. The behavior of the standard library can
|
//! `tokio_net::process::Child` is dropped. The behavior of the standard library can
|
||||||
//! be regained with the [`Child::forget`] method.
|
//! be regained with the [`Child::forget`](crate::process::Child::forget) method.
|
||||||
|
|
||||||
use std::ffi::OsStr;
|
use std::ffi::OsStr;
|
||||||
use std::future::Future;
|
use std::future::Future;
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Asynchronous synchronization primitives.
|
//! Asynchronous synchronization primitives.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Tokio and Futures based testing utilites
|
//! Tokio and Futures based testing utilites
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Utilities for tracking time.
|
//! Utilities for tracking time.
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! Async TLS streams
|
//! Async TLS streams
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
rust_2018_idioms,
|
rust_2018_idioms,
|
||||||
unreachable_pub
|
unreachable_pub
|
||||||
)]
|
)]
|
||||||
|
#![deny(intra_doc_link_resolution_failure)]
|
||||||
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
|
||||||
|
|
||||||
//! A runtime for writing reliable, asynchronous, and slim applications.
|
//! A runtime for writing reliable, asynchronous, and slim applications.
|
||||||
|
|||||||
Reference in New Issue
Block a user