Skip to main content

RaftConfig

Struct RaftConfig 

Source
pub struct RaftConfig {
    pub node_id: u64,
    pub group_id: u64,
    pub peers: Vec<u64>,
    pub learners: Vec<u64>,
    pub observers: Vec<u64>,
    pub starts_as_learner: bool,
    pub starts_as_observer: bool,
    pub election_timeout_min: Duration,
    pub election_timeout_max: Duration,
    pub heartbeat_interval: Duration,
}
Expand description

Configuration for a Raft node.

Fields§

§node_id: u64

This node’s ID (must be unique within the Raft group).

§group_id: u64

Raft group ID (for Multi-Raft routing).

§peers: Vec<u64>

IDs of voting peers in this group (excluding self).

§learners: Vec<u64>

IDs of non-voting learner peers in this group (excluding self).

Learners receive log replication but do not vote in elections and are not counted in the commit quorum. They are promoted to voters once they catch up — see RaftNode::promote_learner.

§observers: Vec<u64>

IDs of cross-cluster observer peers tracked by this leader.

Observers receive log entries and send advisory acks, but they never participate in leader election and are never counted in the commit quorum. A slow observer does not stall source commits.

§starts_as_learner: bool

Whether this node itself starts in the Learner role (boot-time).

Set true when a new node joins an existing cluster and is created as a learner for a given group; cleared when the node is promoted to voter via promote_self_to_voter.

§starts_as_observer: bool

Whether this node itself starts in the Observer role (boot-time).

Set true when this node is a cross-cluster mirror replica observing a source cluster’s Raft group. An observer never participates in elections and never contributes to the commit quorum. Acks it sends to the source leader are advisory only.

§election_timeout_min: Duration

Minimum election timeout.

§election_timeout_max: Duration

Maximum election timeout.

§heartbeat_interval: Duration

Heartbeat interval (must be << election_timeout_min).

Implementations§

Source§

impl RaftConfig

Source

pub fn cluster_size(&self) -> usize

Total number of voters (self + voter peers).

Learners are excluded. This value drives quorum math and so must never grow transiently while the learner is catching up — that is exactly the safety property the learner phase is designed to give.

Source

pub fn quorum(&self) -> usize

Quorum size: floor(n/2) + 1 over the voter set.

Trait Implementations§

Source§

impl Clone for RaftConfig

Source§

fn clone(&self) -> RaftConfig

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 RaftConfig

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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