Struct TempFile

pub struct TempFile { /* private fields */ }

The path of an existing writable file in a system temporary directory.

Deletes the file on drop. Ignores errors deleting the file.

Example

use temp_file::TempFile;
let t = TempFile::new()
  .unwrap()
  .with_contents(b"abc")
  .unwrap();
// Prints "/tmp/1a9b0".
println!("{:?}", t.path());
assert_eq!(
  "abc",
  std::fs::read_to_string(t.path()).unwrap(),
);
// Prints "/tmp/1a9b1".
println!("{:?}", TempFile::new().unwrap().path());

Implementations

impl TempFile

pub fn new() -> Result<Self, Error>

Create a new empty file in a system temporary directory.

Drop the returned struct to delete the file.

Errors

Returns Err when it fails to create the file.

Example

// Prints "/tmp/1a9b0".
println!("{:?}", temp_file::TempFile::new().unwrap().path());

pub fn in_dir(dir: impl AsRef<Path>) -> Result<Self, Error>

Create a new empty file in dir.

Drop the returned struct to delete the file.

Errors

Returns Err when it fails to create the file.

Example

// Prints "/tmp/temp_uploads/1a9b0".
let dir = std::env::temp_dir().join("temp_uploads");
println!("{:?}", temp_file::TempFile::in_dir(&dir).unwrap().path());

pub fn with_prefix(prefix: impl AsRef<str>) -> Result<Self, Error>

Create a new empty file in a system temporary directory. Use prefix as the first part of the file’s name.

Drop the returned struct to delete the file.

Errors

Returns Err when it fails to create the file.

Example

// Prints "/tmp/ok1a9b0".
println!("{:?}", temp_file::TempFile::with_prefix("ok").unwrap().path());

pub fn with_suffix(suffix: impl AsRef<str>) -> Result<Self, Error>

Create a new empty file in a system temporary directory. Use suffix as the last part of the file’s name.

You can use this to give the filename a particular extension.

Drop the returned struct to delete the file.

Errors

Returns Err when it fails to create the file.

Example

// Prints "/tmp/1a9b0.txt".
println!("{:?}", temp_file::TempFile::with_suffix(".txt").unwrap().path());

pub fn with_contents(self, contents: &[u8]) -> Result<Self, Error>

Write contents to the file.

Errors

Returns Err when it fails to write all of contents to the file.

pub fn cleanup(self) -> Result<(), Error>

Remove the file now. Do nothing later on drop.

Errors

Returns an error if the file exists and we fail to remove it.

pub fn panic_on_cleanup_error(self) -> Self

Make the struct panic on drop if it hits an error while removing the file.

pub fn leak(self)

Do not delete the file.

This is useful when debugging a test.

pub fn path(&self) -> &Path

The path to the file.

Trait Implementations

impl AsRef<Path> for TempFile

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TempFile

fn clone(&self) -> TempFile

Returns a copy of the value.

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

Performs copy-assignment from source.

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.

impl Hash for TempFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TempFile

fn cmp(&self, other: &TempFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TempFile

fn eq(&self, other: &TempFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TempFile

fn partial_cmp(&self, other: &TempFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TempFile

impl StructuralPartialEq for TempFile