Struct DotlockOptions 

pub struct DotlockOptions { /* private fields */ }

Options which can be used to configure how a lock file is created.

This builder exposes the ability to configure how a lock file is created. The Dotlock::create method is an alias for the create method here.

To use DotlockOptions, first call new, then chain calls to methods to set each option required, and finally call create with the full path of the lock file to create. This will give you a io::Result with a Dotlock inside.

Examples

Create a lock file using the defaults:

use dotlock::DotlockOptions;

DotlockOptions::new().create("database.lock").unwrap();

Create a lock file, but failing immediately if creating it fails, and remove lock files older than 5 minutes.

use dotlock::DotlockOptions;
use std::time::Duration;

DotlockOptions::new()
    .tries(1)
    .stale_age(Duration::from_secs(300))
    .create("database.lock").unwrap();

Implementations

impl DotlockOptions

pub fn new() -> Self

Create a new set of options.

pub fn pause<T: Into<Duration>>(self, pause: T) -> Self

Set the time Dotlock will pause between attempts to create the lock file. Defaults to 5 seconds.

pub fn tries(self, tries: usize) -> Self

Set the number of times Dotlock will try to create the lock file. Defaults to 10 times.

pub fn permissions(self, perm: Permissions) -> Self

Set the permissions on the newly created lock file. If not set, the lock file permissions will be based on the current umask.

pub fn stale_age<T: Into<Duration>>(self, age: T) -> Self

Set the age at which a lock file is considered stale. If not set, the existing file age will not be considered for staleness.

pub fn create<T: Into<PathBuf>>(self, path: T) -> Result<Dotlock>

Create the lock file at path with the options in self.

Trait Implementations

impl Debug for DotlockOptions

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

Formats the value using the given formatter.