FileLockProvider

distributed_lock_file::provider

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>) -> LockResult<Self>

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) -> Self::Lock

Creates a lock with the given name.

Auto Trait Implementations§

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<U> 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> LockProviderExt for T
where T: LockProvider,

Source§

fn acquire_lock( &self, name: &str, timeout: Option<Duration>, ) -> impl Future<Output = Result<<Self::Lock as DistributedLock>::Handle, LockError>> + Send
where Self: Sync,

Acquires a lock by name, returning the handle. Read more
Source§

fn try_acquire_lock( &self, name: &str, ) -> impl Future<Output = Result<Option<<Self::Lock as DistributedLock>::Handle>, LockError>> + Send
where Self: Sync,

Tries to acquire a lock by name. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more