aboutsummaryrefslogtreecommitdiff
path: root/src/doc/mod.rs
diff options
context:
space:
mode:
authorJoel Galenson <jgalenson@google.com>2021-06-22 09:28:11 -0700
committerJoel Galenson <jgalenson@google.com>2021-06-22 09:28:30 -0700
commitb53dd06ad19d902c2155b2f616725b14b423a776 (patch)
treeb92904fad1f985434ad7622c3960e6e670b1c918 /src/doc/mod.rs
parent8c2e0e8165f4f0132f3a5c78337fbba15b102768 (diff)
downloadtokio-b53dd06ad19d902c2155b2f616725b14b423a776.tar.gz
Upgrade rust/crates/tokio to 1.7.1
Test: make Change-Id: I7ebd839df13023db6f2057e09d8b73967436b856
Diffstat (limited to 'src/doc/mod.rs')
-rw-r--r--src/doc/mod.rs23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/doc/mod.rs b/src/doc/mod.rs
new file mode 100644
index 0000000..12c2247
--- /dev/null
+++ b/src/doc/mod.rs
@@ -0,0 +1,23 @@
+//! Types which are documented locally in the Tokio crate, but does not actually
+//! live here.
+//!
+//! **Note** this module is only visible on docs.rs, you cannot use it directly
+//! in your own code.
+
+/// The name of a type which is not defined here.
+///
+/// This is typically used as an alias for another type, like so:
+///
+/// ```rust,ignore
+/// /// See [some::other::location](https://example.com).
+/// type DEFINED_ELSEWHERE = crate::doc::NotDefinedHere;
+/// ```
+///
+/// This type is uninhabitable like the [`never` type] to ensure that no one
+/// will ever accidentally use it.
+///
+/// [`never` type]: https://doc.rust-lang.org/std/primitive.never.html
+pub enum NotDefinedHere {}
+
+pub mod os;
+pub mod winapi;