Skip to main content

PreVote

Struct PreVote 

Source
pub struct PreVote {
    pub term: Term,
    pub candidate: NodeId,
    pub last_log_index: Index,
    pub last_log_term: Term,
}
Expand description

A candidate’s pre-vote probe, sent before it commits to a real election.

Pre-voting (Raft thesis §9.6) is a disruption guard. Before a node increments its term and campaigns for real, it asks its peers whether they would vote for it at the next term — without bumping anyone’s term. A peer grants only if it has no active leader and the candidate’s log is up to date (the same election restriction a real vote applies). The candidate runs a real RequestVote election only once a quorum of pre-votes says yes.

The point is that a node partitioned away from the cluster never collects a pre-vote majority, so it never inflates its term. When it rejoins it does not force the established leader to step down, which is the disruption a plain election would cause. Unlike RequestVote, a pre-vote changes no persistent state on either side.

§Examples

use raft_io::PreVote;

// The `term` is the *hypothetical* term the candidate would campaign at —
// one past its current term — not a term it has adopted.
let pv = PreVote { term: 5, candidate: 2, last_log_index: 9, last_log_term: 3 };
assert_eq!(pv.candidate, 2);

Fields§

§term: Term

The hypothetical term the candidate would campaign at — one past its current term. It is not a term the candidate has adopted; a recipient neither stores it nor steps down for it.

§candidate: NodeId

The candidate seeking the pre-vote.

§last_log_index: Index

Index of the candidate’s last log entry.

§last_log_term: Term

Term of the candidate’s last log entry.

Trait Implementations§

Source§

impl Clone for PreVote

Source§

fn clone(&self) -> PreVote

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PreVote

Source§

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

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

impl Deserialize for PreVote

Source§

fn deserialize<__D: Decode + ?Sized>(__decoder: &mut __D) -> Result<Self>

Read a value of Self from the decoder, advancing its cursor. Read more
Source§

fn deserialize_many<D>( decoder: &mut D, count: usize, ) -> Result<Vec<Self>, SerialError>
where D: Decode + ?Sized,

Read count consecutive Self values into a freshly-allocated Vec. Read more
Source§

impl Eq for PreVote

Source§

impl PartialEq for PreVote

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Serialize for PreVote

Source§

fn serialize<__E: Encode + ?Sized>(&self, __encoder: &mut __E) -> Result<()>

Append the encoded bytes of self to encoder. Read more
Source§

fn serialize_slice<E>( slice: &[Self], encoder: &mut E, ) -> Result<(), SerialError>
where E: Encode + ?Sized, Self: Sized,

Append the encoded bytes of every element of slice to encoder. Read more
Source§

impl StructuralPartialEq for PreVote

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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.
Source§

impl<E> WithErrorCode<E> for E

Source§

fn with_code(self, code: impl Into<String>) -> CodedError<E>

Attach an error code to an error