Struct git_lock::Marker

pub struct Marker { /* private fields */ }

Locks a resource to allow related resources to be updated using files.

As opposed to the File type this one won’t keep the tempfile open for writing and thus consumes no system resources, nor can it be persisted.

Implementations

impl Marker

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

Like acquire_to_update_resource() but without the possibility to make changes and commit them.

If boundary_directory is given, non-existing directories will be created automatically and removed in the case of a rollback.

impl Marker

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

Commit the changes written to the previously open file and overwrite the original file atomically, returning the resource path on success.

This fails for markers which weren’t created with File::close()

impl Marker

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

Examples found in repository

src/commit.rs (line 49)

    pub fn commit(mut self) -> Result<PathBuf, Error<Self>> {
        if !self.created_from_file {
            return Err(Error {
                error: std::io::Error::new(
                    std::io::ErrorKind::Other,
                    "refusing to commit marker that was never opened",
                ),
                instance: self,
            });
        }
        let resource_path = self.resource_path();
        match self.inner.persist(&resource_path) {
            Ok(_) => Ok(resource_path),
            Err(err) => Err(Error {
                error: err.error,
                instance: {
                    self.inner = err.handle;
                    self
                },
            }),
        }
    }

Trait Implementations

impl Debug for Marker

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

Formats the value using the given formatter.