add target cfg for docs

tokio-rs · Mar 21, 2023 · 4cfe812 · 4cfe812
1 parent 28b2ad6
commit 4cfe812
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/tokio/src/io/async_fd.rs b/tokio/src/io/async_fd.rs
@@ -521,6 +521,7 @@ impl<T: AsRawFd> AsyncFd<T> {
     /// [`AsyncFdReadyGuard`].
     #[allow(clippy::needless_lifetimes)] // The lifetime improves rustdoc rendering.
     #[cfg(any(target_os = "linux", target_os = "android"))]
+    #[cfg_attr(docsrs, doc(cfg(any(target_os = "linux", target_os = "android"))))]
     pub async fn priority<'a>(&'a self) -> io::Result<AsyncFdReadyGuard<'a, T>> {
         self.readiness(Interest::PRIORITY).await
     }
@@ -533,6 +534,7 @@ impl<T: AsRawFd> AsyncFd<T> {
     /// resource mutably when handling the [`AsyncFdReadyMutGuard`].
     #[allow(clippy::needless_lifetimes)] // The lifetime improves rustdoc rendering.
     #[cfg(any(target_os = "linux", target_os = "android"))]
+    #[cfg_attr(docsrs, doc(cfg(any(target_os = "linux", target_os = "android"))))]
     pub async fn priority_mut<'a>(&'a mut self) -> io::Result<AsyncFdReadyMutGuard<'a, T>> {
         self.readiness_mut(Interest::PRIORITY).await
     }

diff --git a/tokio/src/io/interest.rs b/tokio/src/io/interest.rs
@@ -46,6 +46,7 @@ impl Interest {
 
     /// Returns a `Interest` set representing priority completion interests.
     #[cfg(any(target_os = "linux", target_os = "android"))]
+    #[cfg_attr(docsrs, doc(cfg(any(target_os = "linux", target_os = "android"))))]
     pub const PRIORITY: Interest = Interest(mio::Interest::PRIORITY);
 
     /// Returns true if the value includes readable interest.

diff --git a/tokio/src/io/ready.rs b/tokio/src/io/ready.rs
@@ -163,6 +163,8 @@ impl Ready {
     /// assert!(!Ready::WRITABLE.is_priority());
     /// assert!(Ready::PRIORITY.is_priority());
     /// ```
+    #[cfg(any(target_os = "linux", target_os = "android"))]
+    #[cfg_attr(docsrs, doc(cfg(any(target_os = "linux", target_os = "android"))))]
     pub fn is_priority(self) -> bool {
         self.contains(Ready::PRIORITY)
     }