Enum tempfile_fast::PersistableTempFile

pub enum PersistableTempFile {
    Linux(File),
    Fallback(NamedTempFile),
}

An abstraction over different platform-specific temporary file optimisations.

Variants

Linux(File)Fallback(NamedTempFile)

Methods

impl PersistableTempFile

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

Create a temporary file in a given filesystem, or, if the filesystem does not support creating secure temporary files, create a tempfile::NamedTemporaryFile.

impl PersistableTempFile

fn persist_noclobber<P: AsRef<Path>>(self, dest: P) -> Result<(), PersistError>

Store this temporary file into a real file path.

The path must not exist, and must be on the same "filesystem".

fn persist_by_rename<P: AsRef<Path>>(self, dest: P) -> Result<(), PersistError>

Store this temporary file into a real name.

The path must be on the same filesystem. It may exist, and will be overwritten.

This method may create a named temporary file, and, in pathological failure cases, may silently fail to remove this temporary file. Sorry.

Methods from Deref<Target = File>

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

f.sync_all()?;

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

f.sync_data()?;

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

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

Queries metadata about the underlying file.

Examples

use std::fs::File;

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

fn try_clone(&self) -> Result<File, Error>

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()?;

fn set_permissions(&self, perm: Permissions) -> Result<(), Error>

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 PersistableTempFile

fn as_ref(&self) -> &File

Performs the conversion.

impl AsMut<File> for PersistableTempFile

fn as_mut(&mut self) -> &mut File

Performs the conversion.

impl Deref for PersistableTempFile

type Target = File

The resulting type after dereferencing.

fn deref(&self) -> &File

Dereferences the value.

impl DerefMut for PersistableTempFile

fn deref_mut(&mut self) -> &mut File

Mutably dereferences the value.

impl Debug for PersistableTempFile

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

Formats the value using the given formatter.

impl Read for PersistableTempFile

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.

unsafe fn initializer(&self) -> Initializer

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

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

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>

🔬 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.

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 PersistableTempFile

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 PersistableTempFile

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

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

impl<'a> Read for &'a PersistableTempFile

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.

unsafe fn initializer(&self) -> Initializer

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

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

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>

🔬 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.

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<'a> Write for &'a PersistableTempFile

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<'a> Seek for &'a PersistableTempFile

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

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

impl AsRawFd for PersistableTempFile

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.