Struct etcd_client::LeaderKey

pub struct LeaderKey(/* private fields */);

Leader key of election

Implementations

impl LeaderKey

pub const fn new() -> Self

Creates a new leader key.

pub fn with_name(self, name: impl Into<Vec<u8>>) -> Self

The election identifier that corresponds to the leadership key.

pub fn with_key(self, key: impl Into<Vec<u8>>) -> Self

An opaque key representing the ownership of the election.

pub const fn with_rev(self, rev: i64) -> Self

The creation revision of the key

pub const fn with_lease(self, lease: i64) -> Self

The lease ID of the election leader.

pub fn name(&self) -> &[u8]

The name in byte. name is the election identifier that corresponds to the leadership key.

pub fn name_str(&self) -> Result<&str, Error>

The name in string. name is the election identifier that corresponds to the leadership key.

pub unsafe fn name_str_unchecked(&self) -> &str

The name in string. name is the election identifier that corresponds to the leadership key.

Safety

This function is unsafe because it does not check that the bytes of the key are valid UTF-8. If this constraint is violated, undefined behavior results, as the rest of Rust assumes that &strs are valid UTF-8.

pub fn key(&self) -> &[u8]

The key in byte. key is an opaque key representing the ownership of the election. If the key is deleted, then leadership is lost.

pub fn key_str(&self) -> Result<&str, Error>

The key in string. key is an opaque key representing the ownership of the election. If the key is deleted, then leadership is lost.

pub unsafe fn key_str_unchecked(&self) -> &str

The key in string. key is an opaque key representing the ownership of the election. If the key is deleted, then leadership is lost.

Safety

This function is unsafe because it does not check that the bytes of the key are valid UTF-8. If this constraint is violated, undefined behavior results, as the rest of Rust assumes that &strs are valid UTF-8.

pub const fn rev(&self) -> i64

The creation revision of the key. It can be used to test for ownership of an election during transactions by testing the key’s creation revision matches rev.

pub const fn lease(&self) -> i64

The lease ID of the election leader.

Trait Implementations

impl Clone for LeaderKey

fn clone(&self) -> LeaderKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LeaderKey

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

Formats the value using the given formatter.

impl Default for LeaderKey

fn default() -> Self

Returns the “default value” for a type.