Struct simplelock::LockBuilder

pub struct LockBuilder { /* fields omitted */ }

Builds a lock from a ConcreteLock implementation using the configurations enabled. See below for all possible configurations. Note, by implementing the ConcreteLock implementation you can wrap it with a LockBuilder to create the Lock interface used in all utility functions.

Implementations

impl LockBuilder

pub fn enable_silent_unlock(self)

If the unlock fails, intermediate computation may be lost. This may not be the behaviour you wished for, so enable silent_unlock. You can then check the lock status afterwards by performing Lock::status.

pub fn enable_try_lock(self)

If the lock is already taken, by default we would hang until it was our turn. By enabling 'try_lock' we instead try to lock but fail immediately with SimpleLockError::AlreadyLocked if we could not acquire it.

pub fn with_silent_unlock(self) -> Self

Performs enable_status_unlock and then returns self so that we can chain additional configurations or a call to build.

pub fn with_try_lock(self) -> Self

Performs enable_try_lock and then returns self so that we can chain additional configurations or a call to build.

pub fn wrap(
    &self,
    concrete: Box<dyn ConcreteLock>
) -> SimpleLockResult<Box<dyn Lock>>

Wraps a ConcreteLock with the configurations enabled with this LockBuilder and returns the simplified Lock interface.

pub fn build(
    &self,
    app_name: impl Into<String>
) -> SimpleLockResult<Box<dyn Lock>>

Create a Lock based on the configurations enabled using the implementation enabled in the Cargo.toml. For example, if the "file" feature is enabled a FileLock will be produced from this build call.

Trait Implementations

impl Clone for LockBuilder

pub fn clone(&self) -> LockBuilder

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LockBuilder

impl Debug for LockBuilder

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

Formats the value using the given formatter.

impl Default for LockBuilder

pub fn default() -> Self

Returns the "default value" for a type.