From c47c445be6e20b49c3382ca6f59be5e9a4044946 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Wed, 11 Jan 2017 09:47:12 -0800 Subject: [PATCH] Add some docs links and such --- src/io/mod.rs | 6 ++++++ src/reactor/poll_evented.rs | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/src/io/mod.rs b/src/io/mod.rs index 3a17d394d..72d89e10a 100644 --- a/src/io/mod.rs +++ b/src/io/mod.rs @@ -2,6 +2,12 @@ //! //! Contains various combinators to work with I/O objects and type definitions //! as well. +//! +//! A description of the high-level I/O combinators can be [found online] in +//! addition to a description of the [low level details]. +//! +//! [found online]: https://tokio.rs/docs/getting-started/core/ +//! [low level details]: https://tokio.rs/docs/going-deeper/core-low-level/ use std::io; diff --git a/src/reactor/poll_evented.rs b/src/reactor/poll_evented.rs index e3d6ee149..33095a95d 100644 --- a/src/reactor/poll_evented.rs +++ b/src/reactor/poll_evented.rs @@ -32,6 +32,10 @@ use reactor::io_token::IoToken; /// It's the responsibility of the wrapper to inform the readiness stream when a /// "would block" I/O event is seen. The readiness stream will then take care of /// any scheduling necessary to get notified when the event is ready again. +/// +/// You can find more information about creating a custom I/O object [online]. +/// +/// [online]: https://tokio.rs/docs/going-deeper/core-low-level/#custom-io pub struct PollEvented { token: IoToken, handle: Remote,