Struct tempfile::NamedTempFile
source · pub struct NamedTempFile { /* private fields */ }
Expand description
A named temporary file.
The default constructor, NamedTempFile::new()
, creates files in
the location returned by std::env::temp_dir()
, but NamedTempFile
can be configured to manage a temporary file in any location
by constructing with NamedTempFile::new_in()
.
Security
This variant is NOT secure/reliable in the presence of a pathological temporary file cleaner.
Resource Leaking
If the program exits before the NamedTempFile
destructor is
run, such as via std::process::exit()
, by segfaulting, or by
receiving a signal like SIGINT
, then the temporary file
will not be deleted.
Use the tempfile()
function unless you absolutely need a named file.
Implementations
sourceimpl NamedTempFile
impl NamedTempFile
sourcepub fn new() -> Result<NamedTempFile>
pub fn new() -> Result<NamedTempFile>
Create a new named temporary file.
See Builder
for more configuration.
Security
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:
-
The file has a short lifetime and your temporary file cleaner is sane (doesn’t delete recently accessed files).
-
You trust every user on your system (i.e. you are the only user).
-
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:
-
You’ll fix it later. No you won’t.
-
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.
Errors
If the file can not be created, Err
is returned.
Examples
Create a named temporary file and write some data to it:
use tempfile::NamedTempFile;
let mut file = NamedTempFile::new()?;
writeln!(file, "Brian was here. Briefly.")?;
sourcepub fn new_in<P: AsRef<Path>>(dir: P) -> Result<NamedTempFile>
pub fn new_in<P: AsRef<Path>>(dir: P) -> Result<NamedTempFile>
Create a new named temporary file in the specified directory.
See NamedTempFile::new()
for details.
sourcepub fn path(&self) -> &Path
pub fn path(&self) -> &Path
Get the temporary file’s path.
Security
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.
Examples
use tempfile::NamedTempFile;
let file = NamedTempFile::new()?;
println!("{:?}", file.path());
sourcepub fn close(self) -> Result<()>
pub fn close(self) -> Result<()>
Close and remove the temporary file.
Use this if you want to detect errors in deleting the file.
Errors
If the file cannot be deleted, Err
is returned.
Examples
use tempfile::NamedTempFile;
let file = NamedTempFile::new()?;
// By closing the `NamedTempFile` explicitly, we can check that it has
// been deleted successfully. If we don't close it explicitly,
// the file will still be deleted when `file` goes out
// of scope, but we won't know whether deleting the file
// succeeded.
file.close()?;
sourcepub fn persist<P: AsRef<Path>>(self, new_path: P) -> Result<File, PersistError>
pub 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
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.
Errors
If the file cannot be moved to the new location, Err
is returned.
Examples
use tempfile::NamedTempFile;
let file = NamedTempFile::new()?;
let mut persisted_file = file.persist("./saved_file.txt")?;
writeln!(persisted_file, "Brian was here. Briefly.")?;
sourcepub fn persist_noclobber<P: AsRef<Path>>(
self,
new_path: P
) -> Result<File, PersistError>
pub fn persist_noclobber<P: AsRef<Path>>(
self,
new_path: P
) -> Result<File, PersistError>
Persist the temporary file at the target path iff no file exists there.
If a file exists at the target path, fail. If this method fails, it will
return self
in the resulting PersistError.
Note: Temporary files cannot be persisted across filesystems. Also Note: This method is not atomic. It can leave the original link to the temporary file behind.
Security
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.
Errors
If the file cannot be moved to the new location or a file already exists there,
Err
is returned.
Examples
use tempfile::NamedTempFile;
let file = NamedTempFile::new()?;
let mut persisted_file = file.persist_noclobber("./saved_file.txt")?;
writeln!(persisted_file, "Brian was here. Briefly.")?;
sourcepub fn reopen(&self) -> Result<File>
pub fn reopen(&self) -> Result<File>
Reopen the temporary file.
This function is useful when you need multiple independent handles to
the same file. It’s perfectly fine to drop the original NamedTempFile
while holding on to File
s returned by this function; the File
s will
remain usable. However, they may not be nameable.
Errors
If the file cannot be reopened, Err
is returned.
Examples
use tempfile::NamedTempFile;
let file = NamedTempFile::new()?;
let another_handle = file.reopen()?;
sourcepub fn as_file_mut(&mut self) -> &mut File
pub fn as_file_mut(&mut self) -> &mut File
Get a mutable reference to the underlying file.
sourcepub fn into_file(self) -> File
pub fn into_file(self) -> File
Convert the temporary file into a std::fs::File
.
The inner file will be deleted.
sourcepub fn into_temp_path(self) -> TempPath
pub fn into_temp_path(self) -> TempPath
Closes the file, leaving only the temporary file path.
This is useful when another process must be able to open the temporary file.
Trait Implementations
sourceimpl AsRawFd for NamedTempFile
impl AsRawFd for NamedTempFile
sourceimpl AsRef<Path> for NamedTempFile
impl AsRef<Path> for NamedTempFile
sourceimpl Debug for NamedTempFile
impl Debug for NamedTempFile
sourceimpl From<PersistError> for NamedTempFile
impl From<PersistError> for NamedTempFile
sourcefn from(error: PersistError) -> NamedTempFile ⓘ
fn from(error: PersistError) -> NamedTempFile ⓘ
sourceimpl<'a> Read for &'a NamedTempFile
impl<'a> Read for &'a NamedTempFile
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read moresourceimpl Read for NamedTempFile
impl Read for NamedTempFile
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read moresourceimpl<'a> Seek for &'a NamedTempFile
impl<'a> Seek for &'a NamedTempFile
sourcefn seek(&mut self, pos: SeekFrom) -> Result<u64>
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
1.55.0 · sourcefn rewind(&mut self) -> Result<(), Error>
fn rewind(&mut self) -> Result<(), Error>
sourceimpl Seek for NamedTempFile
impl Seek for NamedTempFile
sourcefn seek(&mut self, pos: SeekFrom) -> Result<u64>
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
1.55.0 · sourcefn rewind(&mut self) -> Result<(), Error>
fn rewind(&mut self) -> Result<(), Error>
sourceimpl<'a> Write for &'a NamedTempFile
impl<'a> Write for &'a NamedTempFile
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)sourceimpl Write for NamedTempFile
impl Write for NamedTempFile
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)