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
[src]

[src]

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.

[src]

Create a new temporary file in the specified directory.

[src]

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.

[src]

Close and remove the temporary file.

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

[src]

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.

[src]

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.

[src]

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.0
[src]

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 = File::create("foo.txt")?;
f.write_all(b"Hello, world!")?;

f.sync_all()?;

1.0.0
[src]

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 = File::create("foo.txt")?;
f.write_all(b"Hello, world!")?;

f.sync_data()?;

1.0.0
[src]

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 = File::create("foo.txt")?;
f.set_len(10)?;

1.0.0
[src]

Queries metadata about the underlying file.

Examples

use std::fs::File;

let mut f = File::open("foo.txt")?;
let metadata = f.metadata()?;

1.9.0
[src]

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.

Examples

use std::fs::File;

let mut f = File::open("foo.txt")?;
let file_copy = f.try_clone()?;

1.16.0
[src]

Changes the permissions on the underlying file.

Platform-specific behavior

This function currently corresponds to the fchmod function on Unix and the SetFileInformationByHandle function on Windows. Note that, this may change in the future.

Errors

This function will return an error if the user lacks permission change attributes on the underlying file. It may also return an error in other os-specific unspecified cases.

Examples

use std::fs::File;

let file = File::open("foo.txt")?;
let mut perms = file.metadata()?.permissions();
perms.set_readonly(true);
file.set_permissions(perms)?;

Trait Implementations

impl AsRef<File> for NamedTempFile
[src]

[src]

Performs the conversion.

impl AsMut<File> for NamedTempFile
[src]

[src]

Performs the conversion.

impl Debug for NamedTempFile
[src]

[src]

Formats the value using the given formatter.

impl Deref for NamedTempFile
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.

impl DerefMut for NamedTempFile
[src]

[src]

Mutably dereferences the value.

impl From<PersistError> for NamedTempFile
[src]

[src]

Performs the conversion.

impl Drop for NamedTempFile
[src]

[src]

Executes the destructor for this type. Read more

impl Read for NamedTempFile
[src]

[src]

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

[src]

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.6.0
[src]

Read the exact number of bytes required to fill buf. Read more

1.0.0
[src]

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

1.0.0
[src]

Transforms this Read instance to an [Iterator] over its bytes. Read more

[src]

🔬 This is a nightly-only experimental API. (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 [char]s. Read more

1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

1.0.0
[src]

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

impl<'a> Read for &'a NamedTempFile
[src]

[src]

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

[src]

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory. Read more

1.0.0
[src]

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

1.0.0
[src]

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

1.6.0
[src]

Read the exact number of bytes required to fill buf. Read more

1.0.0
[src]

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

1.0.0
[src]

Transforms this Read instance to an [Iterator] over its bytes. Read more

[src]

🔬 This is a nightly-only experimental API. (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 [char]s. Read more

1.0.0
[src]

Creates an adaptor which will chain this stream with another. Read more

1.0.0
[src]

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

impl Write for NamedTempFile
[src]

[src]

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

[src]

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

1.0.0
[src]

Attempts to write an entire buffer into this write. Read more

1.0.0
[src]

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

1.0.0
[src]

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

impl<'a> Write for &'a NamedTempFile
[src]

[src]

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

[src]

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

1.0.0
[src]

Attempts to write an entire buffer into this write. Read more

1.0.0
[src]

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

1.0.0
[src]

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

impl Seek for NamedTempFile
[src]

[src]

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

impl<'a> Seek for &'a NamedTempFile
[src]

[src]

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

impl AsRawHandle for NamedTempFile
[src]

[src]

Extracts the raw handle, without taking any ownership.