Struct FileWriter

pub struct FileWriter<'a> {
    pub writer: BufWriter<File>,
    pub tmp_prefix: String,
    pub tmp_suffix: String,
    /* private fields */
}

A wrapper for atomically replacing a file. The primary field to access here is the writer. You can also configure the temporary prefix and suffix used for the temporary file before it is moved over the final destination.

Call complete() to rename() the file into place.

Fields

writer: BufWriter<File>

Write to the destination file.

tmp_prefix: String

This string will be used as a prefix for the temporary file

tmp_suffix: String

This string will be used as a suffix for the temporary file

Implementations

impl<'a> FileWriter<'a>

pub fn complete_with<P: AsRef<Path>, F>(self, dest: P, f: F) -> Result<()>

where F: Fn(&File) -> Result<()>,

Flush any outstanding buffered data and rename the temporary file into place. The provided closure will be invoked on the real underlying file descriptor before it is renamed into place. You can use this to change file attributes. For example, you can change the mode, extended attributes, or invoke fchmod() to change ownership, etc.

pub fn complete<P: AsRef<Path>>(self, dest: P) -> Result<()>

Flush any outstanding buffered data and rename the temporary file into place.