foundationdb::recipes::leader_election

Enum PollOutcome

Source
pub enum PollOutcome {
    Leader {
        rank: Rank,
        transition: PollTransition,
    },
    Follower {
        owner: ParticipantId,
        rank: Rank,
        lease_duration: Duration,
    },
}
Expand description

The role and fencing rank prepared by one poll transaction attempt.

The rank may protect work staged in the same transaction, but it authorizes no committed or external work until the enclosing Database::run succeeds.

Variants§

§

Leader

The transaction staged this caller as owner with a fresh fencing rank.

PollTransition classifies how that staged ownership was reached.

Fields

§rank: Rank
§transition: PollTransition
§

Follower

A durable owner was observed, but no leadership transition was staged.

The fields form the exact record used to produce the next LocalState::Observation.

Fields

§rank: Rank
§lease_duration: Duration

Implementations§

Source§

impl PollOutcome

Source

pub fn is_leader(&self) -> bool

Returns whether this attempt staged an ownership transition.

Source

pub fn rank(&self) -> Rank

Returns the observed or newly staged durable revision as a fencing rank.

Only Self::is_leader outcomes provide a new rank that can protect work staged by this poll transaction.

Source

pub fn transition(&self) -> PollTransition

Returns the transition classification for this attempt.

PollOutcome::Follower always reports PollTransition::Followed.

Source

pub fn is_takeover(&self) -> bool

Returns whether this attempt staged replacement of a foreign owner.

Source

pub fn is_reacquisition(&self) -> bool

Returns whether this attempt staged reacquisition of this participant’s expired record.

Source

pub fn owner(&self) -> Option<&ParticipantId>

Returns the observed owner when this attempt produced follower state.

The owner is an observation, not an authorization for the caller.

Source

pub fn lease_duration(&self) -> Option<Duration>

Returns the observed persisted lease duration when following.

This duration is relevant to a later poll only with the matching Observation adopted by PollResult::into_next_state.

Trait Implementations§

Source§

impl Clone for PollOutcome

Source§

fn clone(&self) -> PollOutcome

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 PollOutcome

Source§

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

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

impl PartialEq for PollOutcome

Source§

fn eq(&self, other: &PollOutcome) -> 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 PollOutcome

Source§

impl StructuralPartialEq for PollOutcome

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.