Struct LockClient 

pub struct LockClient { /* private fields */ }

A handle to the distributed lock service.

Cloning is cheap (Arc bump) and all clones share the same backend, clock, and node identity.

Implementations

impl LockClient

pub async fn connect(config: LockConfig) -> Result<Self>

Connect using the default InMemoryBackend — single-process locking only. For real distributed locking, connect an EtcdBackend (behind the etcd feature) and pass it to connect_with.

pub async fn connect_with( config: LockConfig, backend: Arc<dyn LockBackend>, ) -> Result<Self>

Connect using an explicit LockBackend (e.g. InMemoryBackend for tests, or EtcdBackend for a real cluster). Bypasses discovery entirely.

pub fn node_id(&self) -> u64

This client’s node id.

pub async fn lock(&self, resource: &str) -> LockBuilder<'_>

Begin acquiring resource. Returns a LockBuilder for fluent configuration; nothing is acquired until acquire is awaited.

Note: this is async to match the spec signature, though it currently does no awaiting itself.

Trait Implementations

impl Clone for LockClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.