Struct ClusterConfig 

pub struct ClusterConfig {

    pub node_id: u64,
    pub listen_addr: SocketAddr,
    pub seed_nodes: Vec<SocketAddr>,
    pub num_groups: u64,
    pub replication_factor: usize,
    pub data_dir: PathBuf,
    pub force_bootstrap: bool,
    pub join_retry: JoinRetryPolicy,
    pub swim_udp_addr: Option<SocketAddr>,
    pub election_timeout_min: Duration,
    pub election_timeout_max: Duration,
    pub install_snapshot_chunk_bytes: u64,
    pub orphan_partial_max_age_secs: u64,
}

Configuration for cluster formation.

Fields

node_id: u64

This node’s unique ID.

listen_addr: SocketAddr

Address to listen on for Raft RPCs.

seed_nodes: Vec<SocketAddr>

Seed node addresses for bootstrap/join.

num_groups: u64

Number of Raft groups to create on bootstrap.

replication_factor: usize

Replication factor (number of replicas per group).

data_dir: PathBuf

Data directory for persistent Raft log storage.

force_bootstrap: bool

Operator escape hatch: bypass the probe phase and bootstrap this node unconditionally even if it is not the lexicographically smallest seed.

Set this only on disaster recovery when the designated bootstrapper is permanently unreachable. Requires listen_addr to be present in seed_nodes (enforced at the caller’s config validation layer).

join_retry: JoinRetryPolicy

Retry policy for the join loop. Defaults to production values (8 attempts, 32 s ceiling). Tests override this with a faster policy.

swim_udp_addr: Option<SocketAddr>

Optional UDP bind address for the SWIM failure detector. None disables SWIM entirely — cluster startup then relies solely on the existing raft transport for membership observations. When Some, the operator is expected to spawn SWIM separately via crate::spawn_swim after the cluster is up and feed the seed list from seed_nodes.

election_timeout_min: Duration

Raft election timeout range. Controls how long a follower waits before starting an election after losing contact with the leader.

election_timeout_max: Duration

install_snapshot_chunk_bytes: u64

Maximum byte size of each InstallSnapshot RPC chunk.

Defaults to 4 MiB. Larger values reduce round-trip count at the cost of higher per-RPC memory pressure. Smaller values improve retry granularity for flaky links.

orphan_partial_max_age_secs: u64

Age in seconds beyond which a .partial snapshot file is considered orphaned and can be removed by the GC sweep.

Defaults to 300 s (5 min). A partial file is orphaned when the leader that was sending it has since lost leadership or crashed.

Trait Implementations

impl Clone for ClusterConfig

fn clone(&self) -> ClusterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterConfig

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

Formats the value using the given formatter.