Struct swap::file_truncator::FileTruncator

pub struct FileTruncator {
    worker: Option<WorkerThread<Result<File>>>,
}

Truncates a file to length 0, in the background when possible.

Truncating a large file can result in a significant amount of IO when updating filesystem metadata. When possible, FileTruncator truncates a given file gradually over time to avoid competing with higher prioirty IO.

Fields

worker: Option<WorkerThread<Result<File>>>

Implementations

impl FileTruncator

pub fn new(file: File) -> Result<Self>

Creates an new FileTruncator to truncate the given file.

Arguments

• file - The file to truncate.

fn new_inner(timer: Box<dyn TimerTrait>, file: File) -> Result<Self>

pub fn take_file(self) -> Result<File>

Retrieves the underlying file, which is guaranteed to be truncated.

If this function is called while the background worker thread has not finished, it may block briefly while stopping the background worker.

Trait Implementations

impl Drop for FileTruncator

fn drop(&mut self)

Executes the destructor for this type.