d-engine-core 0.2.3

Pure Raft consensus algorithm - for building custom Raft-based systems
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

//! Snapshot policy aggregation module.
//! Defines interfaces and manages different snapshot triggering strategies.

mod composite;
mod log_size;
mod time_based;
#[allow(unused)]
pub(crate) use composite::*;
use d_engine_proto::common::LogId;
pub use log_size::*;
#[allow(unused)]
pub(crate) use time_based::*;

use crate::cluster::is_leader;

#[cfg(test)]
mod composite_test;
#[cfg(test)]
mod log_size_test;
#[cfg(test)]
mod time_based_test;

#[cfg(any(test, feature = "__test_support"))]
use mockall::automock;

#[cfg_attr(any(test, feature = "__test_support"), automock)]
pub trait SnapshotPolicy: Send + Sync {
    fn should_trigger(
        &self,
        ctx: &SnapshotContext,
    ) -> bool;

    /// Should be called after the snapshot is created successfully
    #[allow(unused)]
    fn mark_snapshot_created(&mut self);
}

#[derive(Clone, Debug)]
pub struct SnapshotContext {
    pub role: i32,
    pub last_included: LogId,
    pub last_applied: LogId,
    pub current_term: u64,
}

impl SnapshotContext {
    #[allow(unused)]
    pub fn is_leader(&self) -> bool {
        is_leader(self.role)
    }
}