Struct LockPrefix

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

Prefix pattern for lock path creation.

This struct carries path prefix for ephemeral lock path, name filter for candidate contenders and hint to find created lock path in case of Error::ConnectionLoss.

Implementations

impl<'a> LockPrefix<'a>

pub fn new_curator(dir: &'a str, name: &'a str) -> Result<Self, Error>

Apache Curator compatible unique prefix pattern, the final lock path will be {dir}/_c_{uuid}-{name}{ephemeral_sequence}.

Notable lock names

• latch- for LeaderLatch.
• lock- for LeaderSelector and InterProcessMutex.

pub fn new_shared(prefix: &'a str) -> Result<Self, Error>

Shared path prefix, the final lock path will be {prefix}{ephemeral_sequence}.

CAUTION

All contenders share same prefix, so concurrent contenders must not share same session client. Otherwise, the lock could be ruined in case of Error::ConnectionLoss as there is no way to differentiate contenders using same session.

Notable usages

• Uses “{dir}/n-” as prefix for ZooKeeper java client’s LeaderElectionSupport.

pub fn new_custom(prefix: String, name: &'a str) -> Result<Self, Error>

Custom path prefix, the final lock path will be {prefix}{ephemeral_sequence}.

CAUTION

Don’t reuse same prefix among clients with same session. See LockPrefix::new_shared for details.

API

It is intentional for prefix parameter to be String but not impl Into<String> nor impl Into<Cow<'a, str>>, so to attract attention for best wish.

Notable usages

• Uses “{dir}/x-{session_id}-” as prefix and “x-” or “” as name for ZooKeeper java client’s WriteLock.

Trait Implementations

impl<'a> Debug for LockPrefix<'a>

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

Formats the value using the given formatter.