Struct 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.

Note that permissions will be set to 0o666, which usually results in 0o644 after passing a default umask, on Unix systems.

Warning of potential resource leak

Please note that the underlying file will remain if destructors don’t run, as is the case when interrupting the application. This results in the resource being locked permanently unless the lock file is removed by other means. See the crate documentation for more information.

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

Like acquire_to_hold_resource(), but allows to set filesystem permissions using make_permissions.

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

Trait Implementations

impl Debug for Marker

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

Formats the value using the given formatter.