Struct agreed::config::ConfigBuilder

pub struct ConfigBuilder {
    pub cluster_name: String,
    pub election_timeout_min: Option<u64>,
    pub election_timeout_max: Option<u64>,
    pub heartbeat_interval: Option<u64>,
    pub max_payload_entries: Option<u64>,
    pub replication_lag_threshold: Option<u64>,
    pub snapshot_policy: Option<SnapshotPolicy>,
    pub snapshot_max_chunk_size: Option<u64>,
}

A configuration builder to ensure that runtime config is valid.

For election timeout config & heartbeat interval configuration, it is recommended that §5.6 of the Raft spec is considered in order to set the appropriate values.

Fields

cluster_name: String

The application specific name of this Raft cluster.

election_timeout_min: Option<u64>

The minimum election timeout, in milliseconds.

election_timeout_max: Option<u64>

The maximum election timeout, in milliseconds.

heartbeat_interval: Option<u64>

The interval at which leaders will send heartbeats to followers to avoid election timeout.

max_payload_entries: Option<u64>

The maximum number of entries per payload allowed to be transmitted during replication.

replication_lag_threshold: Option<u64>

The distance behind in log replication a follower must fall before it is considered “lagging”.

snapshot_policy: Option<SnapshotPolicy>

The snapshot policy.

snapshot_max_chunk_size: Option<u64>

The maximum snapshot chunk size.

Implementations

impl ConfigBuilder

pub fn election_timeout_min(self, val: u64) -> Self

Set the desired value for election_timeout_min.

pub fn election_timeout_max(self, val: u64) -> Self

Set the desired value for election_timeout_max.

pub fn heartbeat_interval(self, val: u64) -> Self

Set the desired value for heartbeat_interval.

pub fn max_payload_entries(self, val: u64) -> Self

Set the desired value for max_payload_entries.

pub fn replication_lag_threshold(self, val: u64) -> Self

Set the desired value for replication_lag_threshold.

pub fn snapshot_policy(self, val: SnapshotPolicy) -> Self

Set the desired value for snapshot_policy.

pub fn snapshot_max_chunk_size(self, val: u64) -> Self

Set the desired value for snapshot_max_chunk_size.

pub fn validate(self) -> Result<Config, ConfigError>

Validate the state of this builder and produce a new Config instance if valid.

Trait Implementations

impl Debug for ConfigBuilder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ConfigBuilder

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

Serialize this value into the given Serde serializer.