Function no_std_compat::fs::remove_file

1.0.0 · source ·
pub fn remove_file<P>(path: P) -> Result<(), Error>
where P: AsRef<Path>,
Expand description

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).

§Platform-specific behavior

This function currently corresponds to the unlink function on Unix and the DeleteFile function on Windows. Note that, this may change in the future.

§Errors

This function will return an error in the following situations, but is not limited to just these cases:

  • path points to a directory.
  • The file doesn’t exist.
  • The user lacks permissions to remove the file.

§Examples

use std::fs;

fn main() -> std::io::Result<()> {
    fs::remove_file("a.txt")?;
    Ok(())
}