Files
tokio/tokio-fs/src/remove_file.rs
T

51 lines
1.2 KiB
Rust
Raw Normal View History

use std::fs;
2019-07-11 11:05:49 -05:00
use std::future::Future;
use std::io;
use std::path::Path;
2019-07-11 11:05:49 -05:00
use std::pin::Pin;
use std::task::Context;
use std::task::Poll;
/// Removes a file from the filesystem.
///
/// Note that there is no
/// guarantee that the file is immediately deleted (e.g. depending on
/// platform, other open file descriptors may prevent immediate removal).
///
/// This is an async version of [`std::fs::remove_file`][std]
///
/// [std]: https://doc.rust-lang.org/std/fs/fn.remove_file.html
pub fn remove_file<P: AsRef<Path>>(path: P) -> RemoveFileFuture<P> {
RemoveFileFuture::new(path)
}
/// Future returned by `remove_file`.
#[derive(Debug)]
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct RemoveFileFuture<P>
where
2019-02-21 11:56:15 -08:00
P: AsRef<Path>,
{
path: P,
}
impl<P> RemoveFileFuture<P>
where
2019-02-21 11:56:15 -08:00
P: AsRef<Path>,
{
fn new(path: P) -> RemoveFileFuture<P> {
2019-02-21 11:56:15 -08:00
RemoveFileFuture { path: path }
}
}
impl<P> Future for RemoveFileFuture<P>
where
2019-02-21 11:56:15 -08:00
P: AsRef<Path>,
{
2019-07-11 11:05:49 -05:00
type Output = io::Result<()>;
2019-07-11 11:05:49 -05:00
fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output> {
2019-05-14 10:27:36 -07:00
crate::blocking_io(|| fs::remove_file(&self.path))
}
}