Merge pull request #320 from Wassasin/183-async-path

Implement async Path & PathBuf

Author: yoshuawuyts

src/fs/canonicalize.rs

@@ -1,6 +1,5 @@
-use std::path::{Path, PathBuf};
-
 use crate::io;
+use crate::path::{Path, PathBuf};
 use crate::task::blocking;
 
 /// Returns the canonical form of a path.
@@ -33,5 +32,5 @@ use crate::task::blocking;
 /// ```
 pub async fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
     let path = path.as_ref().to_owned();
-    blocking::spawn(async move { std::fs::canonicalize(path) }).await
+    blocking::spawn(async move { std::fs::canonicalize(&path).map(Into::into) }).await
 }

src/fs/copy.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Copies the contents and permissions of a file to a new location.

src/fs/create_dir.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Creates a new directory.

src/fs/create_dir_all.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Creates a new directory and all of its parents if they are missing.

src/fs/dir_builder.rs

@@ -1,9 +1,8 @@
-use std::path::Path;
-
 use cfg_if::cfg_if;
 
 use crate::future::Future;
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// A builder for creating directories with configurable options.

src/fs/dir_entry.rs

@@ -1,12 +1,12 @@
 use std::ffi::OsString;
 use std::fmt;
-use std::path::PathBuf;
 use std::sync::Arc;
 
 use cfg_if::cfg_if;
 
 use crate::fs::{FileType, Metadata};
 use crate::io;
+use crate::path::PathBuf;
 use crate::task::blocking;
 
 /// An entry in a directory.
@@ -50,7 +50,7 @@ impl DirEntry {
     /// # Ok(()) }) }
     /// ```
     pub fn path(&self) -> PathBuf {
-        self.0.path()
+        self.0.path().into()
     }
 
     /// Reads the metadata for this entry.

src/fs/file.rs

@@ -3,7 +3,6 @@ use std::cmp;
 use std::fmt;
 use std::io::{Read as _, Seek as _, Write as _};
 use std::ops::{Deref, DerefMut};
-use std::path::Path;
 use std::pin::Pin;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::{Arc, Mutex};
@@ -13,6 +12,7 @@ use cfg_if::cfg_if;
 use crate::fs::{Metadata, Permissions};
 use crate::future;
 use crate::io::{self, Read, Seek, SeekFrom, Write};
+use crate::path::Path;
 use crate::prelude::*;
 use crate::task::{self, blocking, Context, Poll, Waker};
 

src/fs/hard_link.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Creates a hard link on the filesystem.

src/fs/metadata.rs

@@ -1,8 +1,7 @@
-use std::path::Path;
-
 use cfg_if::cfg_if;
 
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Reads metadata for a path.

src/fs/open_options.rs

@@ -1,10 +1,9 @@
-use std::path::Path;
-
 use cfg_if::cfg_if;
 
 use crate::fs::File;
 use crate::future::Future;
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// A builder for opening files with configurable options.

src/fs/read.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Reads the entire contents of a file as raw bytes.

src/fs/read_dir.rs

@@ -1,9 +1,9 @@
-use std::path::Path;
 use std::pin::Pin;
 
 use crate::fs::DirEntry;
 use crate::future::Future;
 use crate::io;
+use crate::path::Path;
 use crate::stream::Stream;
 use crate::task::{blocking, Context, JoinHandle, Poll};
 

src/fs/read_link.rs

@@ -1,6 +1,5 @@
-use std::path::{Path, PathBuf};
-
 use crate::io;
+use crate::path::{Path, PathBuf};
 use crate::task::blocking;
 
 /// Reads a symbolic link and returns the path it points to.
@@ -29,5 +28,5 @@ use crate::task::blocking;
 /// ```
 pub async fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
     let path = path.as_ref().to_owned();
-    blocking::spawn(async move { std::fs::read_link(path) }).await
+    blocking::spawn(async move { std::fs::read_link(path).map(Into::into) }).await
 }

src/fs/read_to_string.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Reads the entire contents of a file as a string.

src/fs/remove_dir.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Removes an empty directory.

src/fs/remove_dir_all.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Removes a directory and all of its contents.

src/fs/remove_file.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Removes a file.

src/fs/rename.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Renames a file or directory to a new location.

src/fs/set_permissions.rs

@@ -1,7 +1,6 @@
-use std::path::Path;
-
 use crate::fs::Permissions;
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Changes the permissions of a file or directory.

src/fs/symlink_metadata.rs

@@ -1,7 +1,6 @@
-use std::path::Path;
-
 use crate::fs::Metadata;
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Reads metadata for a path without following symbolic links.

src/fs/write.rs

@@ -1,6 +1,5 @@
-use std::path::Path;
-
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Writes a slice of bytes as the new contents of a file.

src/lib.rs

@@ -55,15 +55,14 @@ pub mod future;
 pub mod io;
 pub mod net;
 pub mod os;
+pub mod path;
 pub mod prelude;
 pub mod stream;
 pub mod sync;
 pub mod task;
 
 cfg_if! {
     if #[cfg(any(feature = "unstable", feature = "docs"))] {
-        #[cfg_attr(feature = "docs", doc(cfg(unstable)))]
-        pub mod path;
         #[cfg_attr(feature = "docs", doc(cfg(unstable)))]
         pub mod pin;
         #[cfg_attr(feature = "docs", doc(cfg(unstable)))]

src/os/unix/fs.rs

@@ -1,10 +1,9 @@
 //! Unix-specific filesystem extensions.
 
-use std::path::Path;
-
 use cfg_if::cfg_if;
 
 use crate::io;
+use crate::path::Path;
 use crate::task::blocking;
 
 /// Creates a new symbolic link on the filesystem.

src/os/unix/net/datagram.rs

@@ -2,7 +2,6 @@
 
 use std::fmt;
 use std::net::Shutdown;
-use std::path::Path;
 
 use mio_uds;
 
@@ -11,6 +10,7 @@ use crate::future;
 use crate::io;
 use crate::net::driver::Watcher;
 use crate::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use crate::path::Path;
 use crate::task::blocking;
 
 /// A Unix datagram socket.

src/os/unix/net/listener.rs

@@ -1,7 +1,6 @@
 //! Unix-specific networking extensions.
 
 use std::fmt;
-use std::path::Path;
 use std::pin::Pin;
 
 use mio_uds;
@@ -12,6 +11,7 @@ use crate::future::{self, Future};
 use crate::io;
 use crate::net::driver::Watcher;
 use crate::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use crate::path::Path;
 use crate::stream::Stream;
 use crate::task::{blocking, Context, Poll};
 

src/os/unix/net/mod.rs

@@ -13,7 +13,8 @@ mod stream;
 cfg_if! {
     if #[cfg(feature = "docs")] {
         use std::fmt;
-        use std::path::Path;
+
+        use crate::path::Path;
 
         /// An address associated with a Unix socket.
         ///
@@ -65,9 +66,8 @@ cfg_if! {
             /// With a pathname:
             ///
             /// ```no_run
-            /// use std::path::Path;
-            ///
             /// use async_std::os::unix::net::UnixListener;
+            /// use async_std::path::Path;
             ///
             /// let socket = UnixListener::bind("/tmp/socket").await?;
             /// let addr = socket.local_addr()?;

src/os/unix/net/stream.rs

@@ -3,7 +3,6 @@
 use std::fmt;
 use std::io::{Read as _, Write as _};
 use std::net::Shutdown;
-use std::path::Path;
 use std::pin::Pin;
 
 use mio_uds;
@@ -12,6 +11,7 @@ use super::SocketAddr;
 use crate::io::{self, Read, Write};
 use crate::net::driver::Watcher;
 use crate::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+use crate::path::Path;
 use crate::task::{blocking, Context, Poll};
 
 /// A Unix stream socket.

src/path/ancestors.rs

@@ -0,0 +1,39 @@
+use std::iter::FusedIterator;
+
+use crate::path::Path;
+
+/// An iterator over [`Path`] and its ancestors.
+///
+/// This `struct` is created by the [`ancestors`] method on [`Path`].
+/// See its documentation for more.
+///
+/// # Examples
+///
+/// ```
+/// use async_std::path::Path;
+///
+/// let path = Path::new("/foo/bar");
+///
+/// for ancestor in path.ancestors() {
+///     println!("{}", ancestor.display());
+/// }
+/// ```
+///
+/// [`ancestors`]: struct.Path.html#method.ancestors
+/// [`Path`]: struct.Path.html
+#[derive(Copy, Clone, Debug)]
+pub struct Ancestors<'a> {
+    pub(crate) next: Option<&'a Path>,
+}
+
+impl<'a> Iterator for Ancestors<'a> {
+    type Item = &'a Path;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        let next = self.next;
+        self.next = next.and_then(Path::parent);
+        next
+    }
+}
+
+impl FusedIterator for Ancestors<'_> {}

src/path/mod.rs

@@ -4,9 +4,13 @@
 //!
 //! [`std::path`]: https://doc.rust-lang.org/std/path/index.html
 
+mod ancestors;
+mod path;
+mod pathbuf;
+
 // Structs re-export
 #[doc(inline)]
-pub use std::path::{Ancestors, Components, Display, Iter, PrefixComponent, StripPrefixError};
+pub use std::path::{Components, Display, Iter, PrefixComponent, StripPrefixError};
 
 // Enums re-export
 #[doc(inline)]
@@ -19,3 +23,7 @@ pub use std::path::MAIN_SEPARATOR;
 // Functions re-export
 #[doc(inline)]
 pub use std::path::is_separator;
+
+use ancestors::Ancestors;
+pub use path::Path;
+pub use pathbuf::PathBuf;