ezraft 0.1.1

A beginner-friendly Raft framework built on openraft
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! Type configuration for EzRaft
//!
//! This module provides the `OpenRaftTypes` wrapper that implements
//! OpenRaft's `RaftTypeConfig` with sensible defaults for any [`EzApp`].

use std::marker::PhantomData;

use openraft::BasicNode;
use openraft::OptionalSend;
use openraft::RaftTypeConfig;
use openraft::Vote;
use openraft::impls::InlineBatch;
use openraft::impls::OneshotResponder;
use openraft::impls::leader_id_std::LeaderId;

use crate::app::EzApp;

/// Wrapper type that implements `RaftTypeConfig` for any `T: EzApp`
///
/// This provides all the default implementations needed for OpenRaft.
pub struct OpenRaftTypes<T>
where T: EzApp
{
    _phantom: PhantomData<T>,
}

impl<T> Copy for OpenRaftTypes<T> where T: EzApp {}

impl<T> Clone for OpenRaftTypes<T>
where T: EzApp
{
    fn clone(&self) -> Self {
        *self
    }
}

impl<T> Default for OpenRaftTypes<T>
where T: EzApp
{
    fn default() -> Self {
        Self { _phantom: PhantomData }
    }
}

impl<T> PartialEq for OpenRaftTypes<T>
where T: EzApp
{
    fn eq(&self, _other: &Self) -> bool {
        true
    }
}

impl<T> Eq for OpenRaftTypes<T> where T: EzApp {}

impl<T> PartialOrd for OpenRaftTypes<T>
where T: EzApp
{
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl<T> Ord for OpenRaftTypes<T>
where T: EzApp
{
    fn cmp(&self, _other: &Self) -> std::cmp::Ordering {
        std::cmp::Ordering::Equal
    }
}

impl<T> std::fmt::Debug for OpenRaftTypes<T>
where T: EzApp
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_tuple("OpenRaftTypes").finish()
    }
}

impl<T> RaftTypeConfig for OpenRaftTypes<T>
where T: EzApp
{
    type D = T::Request;
    // `None` answers framework-generated entries (blank, membership); every user request is
    // answered with `Some` by the state machine.
    type R = Option<T::Response>;
    type NodeId = u64;
    type Node = BasicNode;
    type Term = u64;
    type LeaderId = EzLeaderId;
    type Vote = Vote<EzLeaderId>;
    type Entry = crate::entry::EzEntry<T>;
    type AsyncRuntime = openraft::TokioRuntime;
    type Responder<X>
        = OneshotResponder<Self, X>
    where X: OptionalSend + 'static;
    type Batch<X>
        = InlineBatch<X>
    where X: OptionalSend + 'static;
    type ErrorSource = openraft::AnyError;
}

/// Leader ID type: standard Raft, at most one leader per term
pub type EzLeaderId = LeaderId<u64, u64>;

/// Type alias for the Raft vote
pub type EzVote = Vote<EzLeaderId>;