Struct RaftConfig 

pub struct RaftConfig {

    pub replication: ReplicationConfig,
    pub batching: BatchingConfig,
    pub election: ElectionConfig,
    pub membership: MembershipConfig,
    pub state_machine: StateMachineConfig,
    pub snapshot: SnapshotConfig,
    pub persistence: PersistenceConfig,
    pub learner_catchup_threshold: u64,
    pub learner_check_throttle_ms: u64,
    pub general_raft_timeout_duration_in_ms: u64,
    pub snapshot_rpc_timeout_ms: u64,
    pub auto_join: AutoJoinConfig,
    pub read_consistency: ReadConsistencyConfig,
    pub backpressure: BackpressureConfig,
    pub rpc_compression: RpcCompressionConfig,
    pub watch: WatchConfig,
    pub metrics: MetricsConfig,
}

Configuration parameters for the Raft consensus algorithm implementation

Fields

replication: ReplicationConfig

Configuration settings related to log replication Includes parameters like heartbeat interval and AppendEntries entry count limit

batching: BatchingConfig

Client request batching configuration

Controls flush thresholds for the leader’s propose and linearizable-read buffers. Separate from replication config — this governs the client ingestion layer, not the Leader→Follower replication path.

election: ElectionConfig

Configuration settings for leader election mechanism Controls timeouts and randomization factors for election timing

membership: MembershipConfig

Configuration settings for cluster membership changes Handles joint consensus transitions and cluster reconfiguration rules

state_machine: StateMachineConfig

Configuration settings for state machine behavior Controls state machine operations like lease management, compaction, etc. For backward compatibility, can also be configured via storage in TOML files.

snapshot: SnapshotConfig

Configuration settings for snapshot feature

persistence: PersistenceConfig

Configuration settings for log persistence behavior Controls how and when log entries are persisted to stable storage

learner_catchup_threshold: u64

Maximum allowed log entry gap between leader and learner nodes Learners with larger gaps than this value will trigger catch-up replication Default value is set via default_learner_catchup_threshold() function

learner_check_throttle_ms: u64

Throttle interval (milliseconds) for learner progress checks Prevents excessive checking of learner promotion eligibility Default value is set via default_learner_check_throttle_ms() function

general_raft_timeout_duration_in_ms: u64

Base timeout duration (in milliseconds) for general Raft operations Used as fallback timeout when operation-specific timeouts are not set Default value is set via default_general_timeout() function

snapshot_rpc_timeout_ms: u64

Timeout for snapshot RPC operations (milliseconds)

auto_join: AutoJoinConfig

Configuration settings for new node auto join feature

read_consistency: ReadConsistencyConfig

Configuration for read operation consistency behavior Controls the trade-off between read performance and consistency guarantees

backpressure: BackpressureConfig

Backpressure configuration for client request flow control Prevents unbounded memory growth by rejecting excess requests

rpc_compression: RpcCompressionConfig

RPC compression configuration for different service types

Controls which RPC service types use response compression. Allows fine-tuning for performance optimization based on deployment environment and traffic patterns.

watch: WatchConfig

Configuration for Watch mechanism that monitors key changes Controls event queue sizes and metrics behavior

metrics: MetricsConfig

Performance metrics configuration Controls metrics emission and sampling for observability vs performance trade-off

Implementations

impl RaftConfig

pub fn validate(&self) -> Result<()>

Validates all Raft subsystem configurations

Trait Implementations

impl Clone for RaftConfig

fn clone(&self) -> RaftConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RaftConfig

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

Formats the value using the given formatter.

impl Default for RaftConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RaftConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RaftConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.