Struct NodeConfig 

pub struct NodeConfig {
    pub node_id: OxirsNodeId,
    pub address: SocketAddr,
    pub data_dir: String,
    pub peers: Vec<OxirsNodeId>,
    pub peer_addresses: HashMap<OxirsNodeId, SocketAddr>,
    pub discovery: Option<DiscoveryConfig>,
    pub replication_strategy: Option<ReplicationStrategy>,
    pub use_bft: bool,
    pub region_config: Option<MultiRegionConfig>,
}

Cluster node configuration

Fields

node_id: OxirsNodeId

Unique node identifier

address: SocketAddr

Network address for communication

data_dir: String

Data directory for persistent storage

peers: Vec<OxirsNodeId>

List of peer node IDs

peer_addresses: HashMap<OxirsNodeId, SocketAddr>

Known network addresses of entries in peers, keyed by node id.

Required (for every id in peers) to form a real multi-node Raft cluster — ClusterNode::new feeds this straight into RaftNode::set_network via ConsensusManager::with_raft_network, so the Raft transport (raft_network.rs) knows where to dial each peer and what address to advertise for itself. Left empty for a genuine single-node deployment (peers empty), which never needs it.

discovery: Option<DiscoveryConfig>

Discovery configuration

replication_strategy: Option<ReplicationStrategy>

Replication strategy

use_bft: bool

Use Byzantine fault tolerance instead of Raft.

This field is always present so a caller can request BFT regardless of how the crate was compiled; if it is true but the bft feature was not enabled, ClusterNode::start fails loud rather than silently running Raft.

region_config: Option<MultiRegionConfig>

Multi-region deployment configuration

Implementations

impl NodeConfig

pub fn new(node_id: OxirsNodeId, address: SocketAddr) -> Self

Create a new node configuration

pub fn add_peer(&mut self, peer_id: OxirsNodeId) -> &mut Self

Add a peer to the configuration

pub fn add_peer_address( &mut self, peer_id: OxirsNodeId, address: SocketAddr, ) -> &mut Self

Record (or update) the network address of a peer, so a multi-node Raft cluster can be formed. Does not implicitly add peer_id to peers — call add_peer too if it isn’t already listed.

pub fn with_discovery(self, discovery: DiscoveryConfig) -> Self

Set the discovery configuration

pub fn with_replication_strategy(self, strategy: ReplicationStrategy) -> Self

Set the replication strategy

pub fn with_bft(self, enable: bool) -> Self

Enable Byzantine fault tolerance.

Requesting BFT here always compiles; it only takes effect when the crate is built with the bft feature. Otherwise ClusterNode::start returns an explicit configuration error.

pub fn with_multi_region(self, region_config: MultiRegionConfig) -> Self

Set multi-region configuration

pub fn is_multi_region_enabled(&self) -> bool

Check if multi-region is enabled

pub fn region_id(&self) -> Option<&str>

Get region ID if configured

pub fn availability_zone_id(&self) -> Option<&str>

Get availability zone ID if configured

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NodeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.