Struct temp_file::TempFile

[+] Show declaration

pub struct TempFile { /* fields omitted */ }

[−] Expand description

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, String>[−]

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 with_prefix(prefix: impl AsRef<str>) -> Result<Self, String>[−]

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_contents(self, contents: &[u8]) -> Result<Self, String>[−]

Write contents to the file.

Errors

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

[+] Expand attributes

#[must_use]pub fn path(&self) -> &Path[−]

The path to the file.

Trait Implementations

impl Clone for TempFile[+]

[+] Show hidden undocumented items

fn clone(&self) -> TempFile[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for TempFile[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Drop for TempFile[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl PartialEq<TempFile> for TempFile[+]

[+] Show hidden undocumented items

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TempFile) -> bool[−]

This method tests for !=.

impl PartialOrd<TempFile> for TempFile[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

#[must_use]pub fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]pub fn le(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[must_use]pub fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]pub fn ge(&self, other: &Rhs) -> bool[−]

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

impl StructuralPartialEq for TempFile