mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-19 00:00:09 +02:00
51 lines
1.2 KiB
Rust
51 lines
1.2 KiB
Rust
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 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
|
|
P: AsRef<Path>,
|
|
{
|
|
path: P,
|
|
}
|
|
|
|
impl<P> RemoveFileFuture<P>
|
|
where
|
|
P: AsRef<Path>,
|
|
{
|
|
fn new(path: P) -> RemoveFileFuture<P> {
|
|
RemoveFileFuture { path: path }
|
|
}
|
|
}
|
|
|
|
impl<P> Future for RemoveFileFuture<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_file(&self.path))
|
|
}
|
|
}
|