From c248167173a6e7ecfa8f596a82dca37041aa5132 Mon Sep 17 00:00:00 2001
From: Taiki Endo <te316e89@gmail.com>
Date: Thu, 8 Oct 2020 02:30:25 +0900
Subject: fs: switch to our own DirEntryExt trait (#2921)

---
 tokio/src/fs/open_options.rs             |  2 +-
 tokio/src/fs/os/unix/dir_entry_ext.rs    | 44 ++++++++++++++++++++++++++++++++
 tokio/src/fs/os/unix/mod.rs              |  3 +++
 tokio/src/fs/os/unix/open_options_ext.rs |  3 +--
 tokio/src/fs/read_dir.rs                 | 11 +++-----
 5 files changed, 53 insertions(+), 10 deletions(-)
 create mode 100644 tokio/src/fs/os/unix/dir_entry_ext.rs

(limited to 'tokio/src/fs')

diff --git a/tokio/src/fs/open_options.rs b/tokio/src/fs/open_options.rs
index ba3d9a6c..c1c22d8b 100644
--- a/tokio/src/fs/open_options.rs
+++ b/tokio/src/fs/open_options.rs
@@ -383,7 +383,7 @@ impl OpenOptions {
         Ok(File::from_std(std))
     }
 
-    /// Returns a mutable reference to the the underlying std::fs::OpenOptions
+    /// Returns a mutable reference to the underlying `std::fs::OpenOptions`
     #[cfg(unix)]
     pub(super) fn as_inner_mut(&mut self) -> &mut std::fs::OpenOptions {
         &mut self.0
diff --git a/tokio/src/fs/os/unix/dir_entry_ext.rs b/tokio/src/fs/os/unix/dir_entry_ext.rs
new file mode 100644
index 00000000..2ac56da2
--- /dev/null
+++ b/tokio/src/fs/os/unix/dir_entry_ext.rs
@@ -0,0 +1,44 @@
+use crate::fs::DirEntry;
+use std::os::unix::fs::DirEntryExt as _;
+
+/// Unix-specific extension methods for [`fs::DirEntry`].
+///
+/// This mirrors the definition of [`std::os::unix::fs::DirEntryExt`].
+///
+/// [`fs::DirEntry`]: crate::fs::DirEntry
+/// [`std::os::unix::fs::DirEntryExt`]: std::os::unix::fs::DirEntryExt
+pub trait DirEntryExt: sealed::Sealed {
+    /// Returns the underlying `d_ino` field in the contained `dirent`
+    /// structure.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use tokio::fs;
+    /// use tokio::fs::os::unix::DirEntryExt;
+    ///
+    /// # #[tokio::main]
+    /// # async fn main() -> std::io::Result<()> {
+    /// let mut entries = fs::read_dir(".").await?;
+    /// while let Some(entry) = entries.next_entry().await? {
+    ///     // Here, `entry` is a `DirEntry`.
+    ///     println!("{:?}: {}", entry.file_name(), entry.ino());
+    /// }
+    /// # Ok(())
+    /// # }
+    /// ```
+    fn ino(&self) -> u64;
+}
+
+impl DirEntryExt for DirEntry {
+    fn ino(&self) -> u64 {
+        self.as_inner().ino()
+    }
+}
+
+impl sealed::Sealed for DirEntry {}
+
+pub(crate) mod sealed {
+    #[doc(hidden)]
+    pub trait Sealed {}
+}
diff --git a/tokio/src/fs/os/unix/mod.rs b/tokio/src/fs/os/unix/mod.rs
index 826222eb..a0ae7512 100644
--- a/tokio/src/fs/os/unix/mod.rs
+++ b/tokio/src/fs/os/unix/mod.rs
@@ -8,3 +8,6 @@ pub use self::open_options_ext::OpenOptionsExt;
 
 mod dir_builder_ext;
 pub use self::dir_builder_ext::DirBuilderExt;
+
+mod dir_entry_ext;
+pub use self::dir_entry_ext::DirEntryExt;
diff --git a/tokio/src/fs/os/unix/open_options_ext.rs b/tokio/src/fs/os/unix/open_options_ext.rs
index f20c83d0..6e0fd2ba 100644
--- a/tokio/src/fs/os/unix/open_options_ext.rs
+++ b/tokio/src/fs/os/unix/open_options_ext.rs
@@ -1,11 +1,10 @@
 use crate::fs::open_options::OpenOptions;
-use std::os::unix::fs::OpenOptionsExt as StdOpenOptionsExt;
+use std::os::unix::fs::OpenOptionsExt as _;
 
 /// Unix-specific extensions to [`fs::OpenOptions`].
 ///
 /// This mirrors the definition of [`std::os::unix::fs::OpenOptionsExt`].
 ///
-///
 /// [`fs::OpenOptions`]: crate::fs::OpenOptions
 /// [`std::os::unix::fs::OpenOptionsExt`]: std::os::unix::fs::OpenOptionsExt
 pub trait OpenOptionsExt: sealed::Sealed {
diff --git a/tokio/src/fs/read_dir.rs b/tokio/src/fs/read_dir.rs
index 5af2dcaa..8ca583bc 100644
--- a/tokio/src/fs/read_dir.rs
+++ b/tokio/src/fs/read_dir.rs
@@ -4,8 +4,6 @@ use std::ffi::OsString;
 use std::fs::{FileType, Metadata};
 use std::future::Future;
 use std::io;
-#[cfg(unix)]
-use std::os::unix::fs::DirEntryExt;
 use std::path::{Path, PathBuf};
 use std::pin::Pin;
 use std::sync::Arc;
@@ -233,11 +231,10 @@ impl DirEntry {
         let std = self.0.clone();
         asyncify(move || std.file_type()).await
     }
-}
 
-#[cfg(unix)]
-impl DirEntryExt for DirEntry {
-    fn ino(&self) -> u64 {
-        self.0.ino()
+    /// Returns a reference to the underlying `std::fs::DirEntry`
+    #[cfg(unix)]
+    pub(super) fn as_inner(&self) -> &std::fs::DirEntry {
+        &self.0
     }
 }
-- 
cgit v1.2.3