ruvector-raft 2.0.6

Raft consensus implementation for ruvector distributed metadata
Documentation 
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! Raft consensus implementation for ruvector distributed metadata
//!
//! This crate provides a production-ready Raft consensus implementation
//! following the Raft paper specification for managing distributed metadata
//! in the ruvector vector database.

pub mod election;
pub mod log;
pub mod node;
pub mod rpc;
pub mod state;

pub use node::{RaftNode, RaftNodeConfig};
pub use rpc::{
    AppendEntriesRequest, AppendEntriesResponse, InstallSnapshotRequest, InstallSnapshotResponse,
    RequestVoteRequest, RequestVoteResponse,
};
pub use state::{LeaderState, PersistentState, RaftState, VolatileState};

use thiserror::Error;

/// Result type for Raft operations
pub type RaftResult<T> = Result<T, RaftError>;

/// Errors that can occur during Raft operations
#[derive(Debug, Error)]
pub enum RaftError {
    #[error("Node is not the leader")]
    NotLeader,

    #[error("No leader available")]
    NoLeader,

    #[error("Invalid term: {0}")]
    InvalidTerm(u64),

    #[error("Invalid log index: {0}")]
    InvalidLogIndex(u64),

    #[error("Serialization error: {0}")]
    SerializationEncodeError(#[from] bincode::error::EncodeError),

    #[error("Deserialization error: {0}")]
    SerializationDecodeError(#[from] bincode::error::DecodeError),

    #[error("IO error: {0}")]
    IoError(#[from] std::io::Error),

    #[error("Election timeout")]
    ElectionTimeout,

    #[error("Log inconsistency detected")]
    LogInconsistency,

    #[error("Snapshot installation failed: {0}")]
    SnapshotFailed(String),

    #[error("Configuration error: {0}")]
    ConfigError(String),

    #[error("Internal error: {0}")]
    Internal(String),
}

/// Node identifier type
pub type NodeId = String;

/// Term number in Raft consensus
pub type Term = u64;

/// Log index in Raft log
pub type LogIndex = u64;