Struct tempfile::NamedTempFile

pub struct NamedTempFile(_);

A named temporary file.

This variant is NOT secure/reliable in the presence of a pathological temporary file cleaner.

NamedTempFiles are deleted on drop. As rust doesn't guarantee that a struct will ever be dropped, these temporary files will not be deleted on abort, resource leak, early exit, etc.

Please use TempFile unless you absolutely need a named file.

Methods

impl NamedTempFile

fn new() -> Result<NamedTempFile>

Create a new temporary file.

SECURITY WARNING: This will create a temporary file in the default temporary file directory (platform dependent). These directories are often patrolled by temporary file cleaners so only use this method if you're positive that the temporary file cleaner won't delete your file.

Reasons to use this method: 1. The file has a short lifetime and your temporary file cleaner is sane (doesn't delete recently accessed files). 2. You trust every user on your system (i.e. you are the only user). 3. You have disabled your system's temporary file cleaner or verified that your system doesn't have a temporary file cleaner.

Reasons not to use this method: 1. You'll fix it later. No you won't. 2. You don't care about the security of the temporary file. If none of the "reasons to use this method" apply, referring to a temporary file by name may allow an attacker to create/overwrite your non-temporary files. There are exceptions but if you don't already know them, don't use this method.

fn new_in<P: AsRef<Path>>(dir: P) -> Result<NamedTempFile>

Create a new temporary file in the specified directory.

fn metadata(&self) -> Result<Metadata>

Queries metadata about the underlying file.

fn set_len(&self, size: u64) -> Result<()>

Truncate the file to size bytes.

fn path(&self) -> &Path

Get the temporary file's path.

SECURITY WARNING: Only use this method if you're positive that a temporary file cleaner won't have deleted your file. Otherwise, the path returned by this method may refer to an attacker controlled file.

fn close(self) -> Result<()>

Close and remove the temporary file.

Use this if you want to detect errors in deleting the file.

fn persist<P: AsRef<Path>>(self, new_path: P) -> Result<File, PersistError>

Persist the temporary file at the target path.

If a file exists at the target path, persist will atomically replace it. If this method fails, it will return self in the resulting PersistError.

Note: Temporary files cannot be persisted across filesystems.

SECURITY WARNING: Only use this method if you're positive that a temporary file cleaner won't have deleted your file. Otherwise, you might end up persisting an attacker controlled file.

Trait Implementations

impl Debug for NamedTempFile

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

Formats the value using the given formatter.

impl Drop for NamedTempFile

fn drop(&mut self)

A method called when the value goes out of scope.

impl Read for NamedTempFile

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

Unstable (io)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Write for NamedTempFile

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl Seek for NamedTempFile

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

impl AsRawFd for NamedTempFile

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.