Struct LockClient

pub struct LockClient<'a> { /* private fields */ }

Guard client writes by owned ZooKeeper lock path which will be deleted in background when dropped.

Implementations

impl<'a> LockClient<'a>

pub fn client(&self) -> &'a Client

Underlying client.

pub fn lock_path(&self) -> &str

Lock path.

Caller can watch this path to detect external lock path deletion. See also ZOOKEEPER-91.

pub fn create( &self, path: &str, data: &[u8], options: &CreateOptions<'_>, ) -> impl Future<Output = Result<(Stat, CreateSequence), Error>> + Send + 'a

Similar to Client::create except Error::RuntimeInconsistent if lock lost.

BUG

Stat will be Stat::is_invalid due to bugs in ZooKeeper version before 3.7.2, 3.8.2 and 3.9.0. See ZOOKEEPER-4026 for reference.

pub fn set_data( &self, path: &str, data: &[u8], expected_version: Option<i32>, ) -> impl Future<Output = Result<Stat, Error>> + Send + 'a

Similar to Client::set_data except Error::RuntimeInconsistent if lock lost.

pub fn delete( &self, path: &str, expected_version: Option<i32>, ) -> impl Future<Output = Result<(), Error>> + Send + 'a

Similar to Client::delete except Error::RuntimeInconsistent if lock lost.

pub fn new_check_writer(&self) -> CheckWriter<'a>

Similar to Client::new_check_writer with this lock path.

pub fn into_owned(self) -> OwnedLockClient

Converts to OwnedLockClient.

Trait Implementations

impl<'a> Debug for LockClient<'a>

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

Formats the value using the given formatter.

impl Drop for LockClient<'_>

Deletes lock path in background.

fn drop(&mut self)

Executes the destructor for this type.