Struct etcd_client::LeaderKey

source · [−]

#[repr(transparent)]
pub struct LeaderKey(_);

Expand description

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]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [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]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for LeaderKey

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

Formats the value using the given formatter. Read more

impl From<&LeaderKey> for &LeaderKey

fn from(src: &PbLeaderKey) -> Self

Converts to this type from the input type.

impl From<LeaderKey> for LeaderKey

fn from(key: PbLeaderKey) -> Self

Converts to this type from the input type.

impl From<LeaderKey> for PbLeaderKey

fn from(leader_key: LeaderKey) -> Self

Converts to this type from the input type.

Auto Trait Implementations

impl RefUnwindSafe for LeaderKey

impl Send for LeaderKey

impl Sync for LeaderKey

impl Unpin for LeaderKey

impl UnwindSafe for LeaderKey

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more