Struct git_lock::File

pub struct File { /* fields omitted */ }

Locks a resource to eventually be overwritten with the content of this file.

Dropping the file without committing will delete it, leaving the underlying resource unchanged.

Implementations

impl File

pub fn acquire_to_update_resource(
    at_path: impl AsRef<Path>,
    mode: Fail,
    boundary_directory: Option<PathBuf>
) -> Result<File, Error>

Create a writable lock file with failure mode whose content will eventually overwrite the given resource at_path.

If boundary_directory is given, non-existing directories will be created automatically and removed in the case of a rollback. Otherwise the containing directory is expected to exist, even though the resource doesn’t have to.

impl File

pub fn commit(self) -> Result<(PathBuf, Option<File>), Error<Self>>

Commit the changes written to this lock file and overwrite the original file atomically, returning the resource path and an open file handle on success.

impl File

pub fn with_mut<T>(
    &mut self,
    f: impl FnOnce(&mut File) -> Result<T>
) -> Result<T>

Obtain a mutable reference to the write handle and call f(out) with it.

pub fn close(self) -> Result<Marker>

Close the lock file to prevent further writes and to save system resources. A call to Marker::commit() is allowed on the Marker to write changes back to the resource.

pub fn lock_path(&self) -> &Path

Return the path at which the lock file resides

pub fn resource_path(&self) -> PathBuf

Return the path at which the locked resource resides

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.