Struct FileLockProvider

Source

pub struct FileLockProvider { /* private fields */ }

Expand description

Provider for file-based distributed locks.

Uses OS-level file locking to provide mutual exclusion across processes. Works on any POSIX system (Linux, macOS) and Windows.

Implementations§

Source §

impl FileLockProvider

Source

pub fn builder() -> FileLockProviderBuilder

Returns a new builder for configuring the provider.

Source

pub fn new(directory: impl Into<PathBuf>) -> Result<FileLockProvider, LockError>

Creates a provider using the specified directory.

Convenience method for simple use cases.

Source

pub fn directory(&self) -> &Path

Returns the directory where lock files are stored.

Trait Implementations§

Source §

impl LockProvider for FileLockProvider

Source §

type Lock = FileDistributedLock

The lock type created by this provider.

Source §

fn create_lock(&self, name: &str) -> <FileLockProvider as LockProvider>::Lock

Creates a lock with the given name.

Auto Trait Implementations§

§

impl UnwindSafe for FileLockProvider

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §