Struct NodeBuilder

pub struct NodeBuilder { /* private fields */ }

Builder pattern implementation for constructing a Raft node with configurable components. Provides a fluent interface to set up node configuration, storage, transport, and other dependencies.

Implementations

impl NodeBuilder

pub fn new(cluster_path: Option<&str>, shutdown_signal: Receiver<()>) -> Self

Creates a new NodeBuilder with cluster configuration loaded from file

Arguments

• cluster_path - Optional path to node-specific cluster configuration
• shutdown_signal - Watch channel for graceful shutdown signaling

Panics

Will panic if configuration loading fails (consider returning Result instead)

pub fn from_config( cluster_config: ClusterConfig, shutdown_signal: Receiver<()>, ) -> Self

Constructs NodeBuilder from in-memory cluster configuration

Arguments

• cluster_config - Pre-built cluster configuration
• shutdown_signal - Graceful shutdown notification channel

Usage

let builder = NodeBuilder::from_config(my_config, shutdown_rx);

pub fn init(node_config: RaftNodeConfig, shutdown_signal: Receiver<()>) -> Self

Core initialization logic shared by all construction paths

pub fn raft_log(self, raft_log: ROF<RaftTypeConfig>) -> Self

Sets a custom Raft log storage implementation

pub fn state_machine(self, state_machine: Arc<SMOF<RaftTypeConfig>>) -> Self

Sets a custom state machine implementation

pub fn state_storage(self, state_storage: SSOF<RaftTypeConfig>) -> Self

Sets a custom state storage implementation

pub fn transport(self, transport: TROF<RaftTypeConfig>) -> Self

Sets a custom network transport implementation

pub fn commit_handler(self, commit_handler: COF<RaftTypeConfig>) -> Self

Sets a custom commit handler implementation

pub fn membership(self, membership: MOF<RaftTypeConfig>) -> Self

Sets a custom membership management implementation

pub fn node_config(self, node_config: RaftNodeConfig) -> Self

Replaces the entire node configuration

pub fn build(self) -> Self

Finalizes the builder and constructs the Raft node instance.

Initializes default implementations for any unconfigured components:

• Creates sled-based databases for state machine and logs
• Sets up default gRPC transport
• Initializes commit handling subsystem
• Configures membership management

Panics

Panics if essential components cannot be initialized

pub fn start_metrics_server(self, shutdown_signal: Receiver<()>) -> Self

Starts the metrics server for monitoring node operations.

Launches a Prometheus endpoint on the configured port.

pub async fn start_rpc_server(self) -> Self

Starts the gRPC server for cluster communication.

Panics

Panics if node hasn’t been built or address binding fails

pub fn ready(self) -> Result<Arc<Node<RaftTypeConfig>>>

Returns the built node instance after successful construction.

Errors

Returns Error::NodeFailedToStartError if build hasn’t completed