Struct TempFileBuilder 

pub struct TempFileBuilder { /* private fields */ }

A builder for configuring and creating a TempFile.

Obtain one via TempFile::builder. The file name is composed as {prefix}{random}{suffix}, where the random core is unpredictable and collision-resistant, and the file is created with an exclusive (O_EXCL) create so it never clobbers an existing file.

Example

let file = TempFile::builder()
    .prefix("session_")
    .suffix(".tmp")
    .dir(std::env::temp_dir())
    .create()
    .await?;

let name = file.file_path().file_name().unwrap().to_string_lossy().into_owned();
assert!(name.starts_with("session_"));
assert!(name.ends_with(".tmp"));

Implementations

impl TempFileBuilder

pub fn prefix<S: Into<String>>(self, prefix: S) -> Self

Sets the file name prefix. Defaults to atmp_.

pub fn suffix<S: Into<String>>(self, suffix: S) -> Self

Sets the file name suffix (for example a file extension). Defaults to empty.

pub fn dir<P: Into<PathBuf>>(self, dir: P) -> Self

Sets the directory to create the file in. Defaults to the system temporary directory (std::env::temp_dir).

pub async fn create(self) -> Result<TempFile, Error>

Creates the temporary file with the configured options.

Trait Implementations

impl Clone for TempFileBuilder

fn clone(&self) -> TempFileBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TempFileBuilder

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

Formats the value using the given formatter.