Struct git_tempfile::Registration

pub struct Registration { /* fields omitted */ }

A registered temporary file which will delete itself on drop or if the program is receiving signals that should cause it to terminate.

Note

Signals interrupting the calling thread right after taking ownership of the registered tempfile will cause all but this tempfile to be removed automatically. In the common case it will persist on disk as destructors were not called or didn’t get to remove the file.

In the best case the file is a true temporary with a non-clashing name that ‘only’ fills up the disk, in the worst case the temporary file is used as a lock file which may leave the repository in a locked state forever.

This kind of raciness exists whenever take() is used and can’t be circumvented.

Implementations

impl Registration

pub fn at_path(
    path: impl AsRef<Path>,
    directory: ContainingDirectory,
    cleanup: AutoRemove
) -> Result<Registration>

Create a registered tempfile at the given path, where path includes the desired filename.

Depending on the directory configuration, intermediate directories will be created, and depending on cleanup empty intermediate directories will be removed.

pub fn new(
    containing_directory: impl AsRef<Path>,
    directory: ContainingDirectory,
    cleanup: AutoRemove
) -> Result<Registration>

Create a registered tempfile within containing_directory with a name that won’t clash, and clean it up as specified with cleanup. Control how to deal with intermediate directories with directory.

pub fn take(self) -> Option<NamedTempFile>

Take ownership of the temporary file.

Trait Implementations

impl Drop for Registration

fn drop(&mut self)

Executes the destructor for this type.