Struct tempfile::NamedTempFile
[−]
[src]
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.
Note: To convert a NamedTempFile into a normal temporary file, use the
provided conversion: let my_file: File = my_temp_file.into();. The file
will be automatically deleted on close. However, if you do this, the file's
path will no longer be valid.
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 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.
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 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.
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 Files
returned by this function; the Files will remain usable. However, they may not be
nameable.
Methods from Deref<Target=File>
1.0.0fn sync_all(&self) -> Result<(), Error>
Attempts to sync all OS-internal metadata to disk.
This function will attempt to ensure that all in-core data reaches the filesystem before returning.
Examples
use std::fs::File; use std::io::prelude::*; let mut f = try!(File::create("foo.txt")); try!(f.write_all(b"Hello, world!")); try!(f.sync_all());
1.0.0fn sync_data(&self) -> Result<(), Error>
This function is similar to sync_all, except that it may not
synchronize file metadata to the filesystem.
This is intended for use cases that must synchronize content, but don't need the metadata on disk. The goal of this method is to reduce disk operations.
Note that some platforms may simply implement this in terms of
sync_all.
Examples
use std::fs::File; use std::io::prelude::*; let mut f = try!(File::create("foo.txt")); try!(f.write_all(b"Hello, world!")); try!(f.sync_data());
1.0.0fn set_len(&self, size: u64) -> Result<(), Error>
Truncates or extends the underlying file, updating the size of
this file to become size.
If the size is less than the current file's size, then the file will
be shrunk. If it is greater than the current file's size, then the file
will be extended to size and have all of the intermediate data filled
in with 0s.
Errors
This function will return an error if the file is not opened for writing.
Examples
use std::fs::File; let mut f = try!(File::create("foo.txt")); try!(f.set_len(10));
1.0.0fn metadata(&self) -> Result<Metadata, Error>
Queries metadata about the underlying file.
Examples
use std::fs::File; let mut f = try!(File::open("foo.txt")); let metadata = try!(f.metadata());
fn try_clone(&self) -> Result<File, Error>
file_try_clone): newly added
Creates a new independently owned handle to the underlying file.
The returned File is a reference to the same state that this object
references. Both handles will read and write with the same cursor
position.