fs: add remove_dir_all and RemoveDirAllFuture (#1325)

Adds the sister function to `remove_dir` and mirrors the `create_dir_all` that's already exposed.
This commit is contained in:
Dylan Frankland
2019-07-19 12:09:53 -07:00
committed by Carl Lerche
parent a88308ed9f
commit 12ce75f088
3 changed files with 51 additions and 1 deletions
+2
View File
@@ -43,6 +43,7 @@ mod read;
mod read_dir;
mod read_link;
mod remove_dir;
mod remove_dir_all;
mod remove_file;
mod rename;
mod set_permissions;
@@ -62,6 +63,7 @@ pub use crate::read::{read, ReadFile};
pub use crate::read_dir::{read_dir, DirEntry, ReadDir, ReadDirFuture};
pub use crate::read_link::{read_link, ReadLinkFuture};
pub use crate::remove_dir::{remove_dir, RemoveDirFuture};
pub use crate::remove_dir_all::{remove_dir_all, RemoveDirAllFuture};
pub use crate::remove_file::{remove_file, RemoveFileFuture};
pub use crate::rename::{rename, RenameFuture};
pub use crate::set_permissions::{set_permissions, SetPermissionsFuture};
+46
View File
@@ -0,0 +1,46 @@
use std::fs;
use std::future::Future;
use std::io;
use std::path::Path;
use std::pin::Pin;
use std::task::Context;
use std::task::Poll;
/// Removes a directory at this path, after removing all its contents. Use carefully!
///
/// This is an async version of [`std::fs::remove_dir_all`][std]
///
/// [std]: https://doc.rust-lang.org/std/fs/fn.remove_dir_all.html
pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> RemoveDirAllFuture<P> {
RemoveDirAllFuture::new(path)
}
/// Future returned by `remove_dir_all`.
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct RemoveDirAllFuture<P>
where
P: AsRef<Path>,
{
path: P,
}
impl<P> RemoveDirAllFuture<P>
where
P: AsRef<Path>,
{
fn new(path: P) -> RemoveDirAllFuture<P> {
RemoveDirAllFuture { path }
}
}
impl<P> Future for RemoveDirAllFuture<P>
where
P: AsRef<Path>,
{
type Output = io::Result<()>;
fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output> {
crate::blocking_io(|| fs::remove_dir_all(&self.path))
}
}
+3 -1
View File
@@ -12,4 +12,6 @@ pub use tokio_fs::{
create_dir, create_dir_all, file, hard_link, metadata, os, read_dir, read_link,
};
pub use tokio_fs::{read, write, ReadFile, WriteFile};
pub use tokio_fs::{remove_dir, remove_file, rename, set_permissions, symlink_metadata, File};
pub use tokio_fs::{
remove_dir, remove_dir_all, remove_file, rename, set_permissions, symlink_metadata, File,
};