nodedb-raft 0.1.1

Raft consensus engine for NodeDB — leader election, log replication, and snapshots
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

// SPDX-License-Identifier: BUSL-1.1

//! Raft consensus primitives: leader election, log replication, snapshots,
//! membership change (joint consensus), and snapshot framing.
//!
//! This crate provides the algorithm only — transport, persistence, and
//! state-machine application are the consumer's responsibility. It is
//! consumed by `nodedb-cluster` (Multi-Raft per vShard for replicated
//! collections) and by `nodedb` (single-group Raft for the metadata
//! catalog and the cross-engine surrogate counter).

pub mod error;
pub mod log;
pub mod message;
pub mod node;
pub mod snapshot_framing;
pub mod state;
pub mod storage;
pub mod transport;

pub use error::{RaftError, Result};
pub use log::RaftLog;
pub use message::{
    AppendEntriesRequest, AppendEntriesResponse, InstallSnapshotRequest, InstallSnapshotResponse,
    LogEntry, RequestVoteRequest, RequestVoteResponse,
};
pub use node::{RaftNode, Ready};
pub use snapshot_framing::{
    SNAPSHOT_FORMAT_VERSION, SNAPSHOT_MAGIC, SnapshotEngineId, SnapshotFramingError,
    decode_snapshot_chunk, encode_snapshot_chunk,
};
pub use state::{HardState, NodeRole};
pub use storage::LogStorage;
pub use transport::RaftTransport;