Skip to main content

RaftNode

Struct RaftNode 

Source
pub struct RaftNode {
    pub id: NodeId,
    pub role: RaftRole,
    pub current_term: RaftTerm,
    pub voted_for: Option<NodeId>,
    pub log: RaftLog,
    pub commit_index: u64,
    pub last_applied: u64,
}
Expand description

A Raft consensus node.

Fields§

§id: NodeId

This node’s ID.

§role: RaftRole

Current role.

§current_term: RaftTerm

Latest term this node has seen.

§voted_for: Option<NodeId>

NodeId this node voted for in the current term.

§log: RaftLog

The replicated log.

§commit_index: u64

Index of highest log entry known to be committed.

§last_applied: u64

Index of highest log entry applied to state machine.

Implementations§

Source§

impl RaftNode

Source

pub fn new(id: NodeId) -> Self

Create a new Raft node in Follower state.

Source

pub fn process_vote_request(&mut self, req: &VoteRequest) -> VoteResponse

Process an incoming vote request and return a response.

Grant vote if:

  1. Candidate’s term >= our current term.
  2. We haven’t voted for anyone else this term.
  3. Candidate’s log is at least as up-to-date as ours.
Source

pub fn become_candidate(&mut self)

Transition this node to Candidate and start a new election.

Source

pub fn become_leader(&mut self)

Transition this node to Leader.

Source

pub fn step_down(&mut self, new_term: RaftTerm)

Step down to Follower with a new term (e.g., after seeing higher term).

Trait Implementations§

Source§

impl Debug for RaftNode

Source§

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

Formats the value using the given formatter. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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