Struct etcd_client::LockClient

#[repr(transparent)]
pub struct LockClient { /* fields omitted */ }

Client for Lock operations.

Implementations

impl LockClient

pub async fn lock(
    &mut self,
    name: impl Into<Vec<u8>>,
    options: Option<LockOptions>
) -> Result<LockResponse, Error>

Acquires a distributed shared lock on a given named lock. On success, it will return a unique key that exists so long as the lock is held by the caller. This key can be used in conjunction with transactions to safely ensure updates to etcd only occur while holding lock ownership. The lock is held until Unlock is called on the key or the lease associate with the owner expires.

pub async fn unlock(
    &mut self,
    key: impl Into<Vec<u8>>
) -> Result<UnlockResponse, Error>

Takes a key returned by Lock and releases the hold on lock. The next Lock caller waiting for the lock will then be woken up and given ownership of the lock.

Trait Implementations

impl Clone for LockClient

fn clone(&self) -> LockClient

Returns a copy of the value.

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

Performs copy-assignment from source.