Struct TempDirBuilder 

pub struct TempDirBuilder { /* private fields */ }

A builder for configuring and creating a TempDir.

Obtain one via TempDir::builder. The directory name is composed as {prefix}{random}{suffix} with an unpredictable, collision-resistant random core, created with an exclusive create.

Example

let dir = TempDir::builder()
    .prefix("workspace_")
    .create()
    .await?;

let name = dir.dir_path().file_name().unwrap().to_string_lossy().into_owned();
assert!(name.starts_with("workspace_"));

Implementations

impl TempDirBuilder

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

Sets the directory name prefix. Defaults to atmpd_.

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

Sets the directory name suffix. Defaults to empty.

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

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

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

Creates the temporary directory with the configured options.

Trait Implementations

impl Clone for TempDirBuilder

fn clone(&self) -> TempDirBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TempDirBuilder

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

Formats the value using the given formatter.