Struct TempFile

pub struct TempFile { /* private fields */ }

Wrapper for working with temporary files.

The file will be maintained for the lifetime of the TempFile object.

Implementations

impl TempFile

pub fn new_with_prefix<P: AsRef<OsStr>>(prefix: P) -> Result<TempFile>

Creates the TempFile using a prefix.

Arguments

prefix: The path and filename where to create the temporary file. Six random alphanumeric characters will be added to the end of this to form the filename.

pub fn new_in(path: &Path) -> Result<Self>

Creates the TempFile inside a specific location.

Arguments

path: The path where to create a temporary file with a filename formed from six random alphanumeric characters.

pub fn new() -> Result<Self>

Creates the TempFile.

Creates a temporary file inside $TMPDIR if set, otherwise inside /tmp. The filename will consist of six random alphanumeric characters.

pub fn remove(&mut self) -> Result<()>

Removes the temporary file.

Calling this is optional as dropping a TempFile object will also remove the file. Calling remove explicitly allows for better error handling.

pub fn as_path(&self) -> &Path

Returns the path to the file if the TempFile object that is wrapping the file is still in scope.

If we remove the file by explicitly calling remove, as_path() can still be used to return the path to that file (even though that path does not point at an existing entity anymore). Calling as_path() after remove() is useful, for example, when you need a random path string, but don’t want an actual resource at that path.

pub fn as_file(&self) -> &File

Returns a reference to the File.

pub fn into_file(self) -> File

Consumes the TempFile, returning the wrapped file.

This also removes the file from the system. The file descriptor remains opened and it can be used until the returned file is dropped.

Trait Implementations

impl Debug for TempFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for TempFile

fn drop(&mut self)

Executes the destructor for this type.