Fix more rustdoc links (#518)

* Fix a cut-paste error with -reactor rustdoc links
* Fix more ::reactor rustdoc broken links
* Minor rustdoc typo
* Consistently reference std::io::{Read, Write} in rustdoc/links
This commit is contained in:
David Kellum
2018-08-07 19:45:39 -07:00
committed by Carl Lerche
parent 5304557d1d
commit 4153cc4076
3 changed files with 10 additions and 10 deletions
+1 -1
View File
@@ -13,7 +13,7 @@
//! //!
//! The specific strategy used to manage the tasks is left up to the //! The specific strategy used to manage the tasks is left up to the
//! executor. There are two main flavors of executors: single-threaded and //! executor. There are two main flavors of executors: single-threaded and
//! multithreaded. Tokio provides implementation for both of these in the //! multi-threaded. Tokio provides implementation for both of these in the
//! [`runtime`] module. //! [`runtime`] module.
//! //!
//! # `Executor` trait. //! # `Executor` trait.
+2 -2
View File
@@ -132,8 +132,8 @@
//! [`Poll::poll`]: https://docs.rs/mio/0.6/mio/struct.Poll.html#method.poll //! [`Poll::poll`]: https://docs.rs/mio/0.6/mio/struct.Poll.html#method.poll
//! [`mio::Evented`]: https://docs.rs/mio/0.6/mio/trait.Evented.html //! [`mio::Evented`]: https://docs.rs/mio/0.6/mio/trait.Evented.html
//! [`PollEvented`]: struct.PollEvented.html //! [`PollEvented`]: struct.PollEvented.html
//! [`std::Read`]: https://doc.rust-lang.org/std/io/trait.Read.html //! [`std::io::Read`]: https://doc.rust-lang.org/std/io/trait.Read.html
//! [`std::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html //! [`std::io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
pub use tokio_reactor::{ pub use tokio_reactor::{
Reactor, Reactor,
+7 -7
View File
@@ -13,12 +13,12 @@ use std::io::{self, Read, Write};
use std::sync::atomic::AtomicUsize; use std::sync::atomic::AtomicUsize;
use std::sync::atomic::Ordering::Relaxed; use std::sync::atomic::Ordering::Relaxed;
/// Associates an I/O resource that implements the [`std::Read`] and / or /// Associates an I/O resource that implements the [`std::io::Read`] and/or
/// [`std::Write`] traits with the reactor that drives it. /// [`std::io::Write`] traits with the reactor that drives it.
/// ///
/// `PollEvented` uses [`Registration`] internally to take a type that /// `PollEvented` uses [`Registration`] internally to take a type that
/// implements [`mio::Evented`] as well as [`std::Read`] and or [`std::Write`] /// implements [`mio::Evented`] as well as [`std::io::Read`] and or
/// and associate it with a reactor that will drive it. /// [`std::io::Write`] and associate it with a reactor that will drive it.
/// ///
/// Once the [`mio::Evented`] type is wrapped by `PollEvented`, it can be /// Once the [`mio::Evented`] type is wrapped by `PollEvented`, it can be
/// used from within the future's execution model. As such, the `PollEvented` /// used from within the future's execution model. As such, the `PollEvented`
@@ -77,15 +77,15 @@ use std::sync::atomic::Ordering::Relaxed;
/// These events are included as part of the read readiness event stream. The /// These events are included as part of the read readiness event stream. The
/// write readiness event stream is only for `Ready::writable()` events. /// write readiness event stream is only for `Ready::writable()` events.
/// ///
/// [`std::Read`]: https://doc.rust-lang.org/std/io/trait.Read.html /// [`std::io::Read`]: https://doc.rust-lang.org/std/io/trait.Read.html
/// [`std::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html /// [`std::io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
/// [`AsyncRead`]: ../io/trait.AsyncRead.html /// [`AsyncRead`]: ../io/trait.AsyncRead.html
/// [`AsyncWrite`]: ../io/trait.AsyncWrite.html /// [`AsyncWrite`]: ../io/trait.AsyncWrite.html
/// [`mio::Evented`]: https://docs.rs/mio/0.6/mio/trait.Evented.html /// [`mio::Evented`]: https://docs.rs/mio/0.6/mio/trait.Evented.html
/// [`Registration`]: struct.Registration.html /// [`Registration`]: struct.Registration.html
/// [`TcpListener`]: ../net/struct.TcpListener.html /// [`TcpListener`]: ../net/struct.TcpListener.html
/// [`clear_read_ready`]: #method.clear_read_ready /// [`clear_read_ready`]: #method.clear_read_ready
/// [`clear_read_ready`]: #method.clear_read_ready /// [`clear_write_ready`]: #method.clear_write_ready
/// [`poll_read_ready`]: #method.poll_read_ready /// [`poll_read_ready`]: #method.poll_read_ready
/// [`poll_write_ready`]: #method.poll_write_ready /// [`poll_write_ready`]: #method.poll_write_ready
pub struct PollEvented<E: Evented> { pub struct PollEvented<E: Evented> {