foundationdb::recipes::leader_election

Struct Leadership

Source
pub struct Leadership { /* private fields */ }
Expand description

The exact durable owner record a caller may attempt to renew before local expiry.

It is caller-local evidence, not a lease granted by a durable clock: a poll must still verify the participant, rank, and persisted duration against durable state. A later successful leader poll, including renewal by this same participant, supersedes this token’s fencing rank.

Implementations§

Source§

impl Leadership

Source

pub fn participant(&self) -> &ParticipantId

Returns the process incarnation this token identifies as owner.

A renewal attempt additionally requires this to match the participant passed to super::LeaderElection::poll.

Source

pub fn rank(&self) -> Rank

Returns this token’s durable revision as a fencing rank.

A later successful leader poll supersedes this rank, including renewal by the same participant.

Source

pub fn lease_duration(&self) -> Duration

Returns the lease duration persisted with this token.

It bounds local renewability from Self::last_renewed_at, not the durable owner’s lifetime.

Source

pub fn last_renewed_at(&self) -> Duration

Returns the caller-clock time supplied at the successful poll attempt’s start.

A renewal is locally eligible only while elapsed time from this value is less than Self::lease_duration. It must be compared only with the same caller’s monotonic clock.

Trait Implementations§

Source§

impl Clone for Leadership

Source§

fn clone(&self) -> Leadership

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
Source§

impl Debug for Leadership

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Leadership

Source§

fn eq(&self, other: &Leadership) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Leadership

Source§

impl StructuralPartialEq for Leadership

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.