openraft 0.10.0-alpha.18

Advanced Raft consensus
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

mod raft_term_impls;

use std::fmt::Debug;
use std::fmt::Display;

use openraft_macros::since;

use crate::base::OptionalFeatures;

/// Type representing a Raft term number.
///
/// A term is a logical clock in Raft that is used to detect obsolete information,
/// such as old leaders. It must be totally ordered and monotonically increasing.
///
/// Common implementations are provided for standard integer types like `u64`, `u32`, etc.
#[since(version = "0.10.0")]
pub trait RaftTerm
where Self: OptionalFeatures + Ord + Debug + Display + Copy + Default + 'static
{
    /// Returns the next term.
    ///
    /// Must satisfy: `self < self.next()`
    fn next(&self) -> Self;

    /// Convert to u64 for metrics recording.
    ///
    /// Returns `None` if the term cannot be represented as u64.
    /// Implementers must explicitly choose whether their term type
    /// can be converted to u64 for metrics purposes.
    fn as_u64(&self) -> Option<u64>;
}