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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use std::fmt;

use openraft_macros::since;

use crate::base::OptionalSend;
use crate::node::Node;
use crate::node::NodeId;
use crate::storage::SnapshotMeta;
use crate::vote::RaftCommittedLeaderId;

/// The data associated with the current snapshot.
#[since(version = "0.10.0", change = "from `Snapshot<C>` to `Snapshot<CLID, NID, N, SD>`")]
#[since(version = "0.10.0", change = "SnapshotData without Box")]
#[derive(Debug, Clone)]
pub struct Snapshot<CLID, NID, N, SD>
where
    CLID: RaftCommittedLeaderId,
    NID: NodeId,
    N: Node,
    SD: OptionalSend + 'static,
{
    /// metadata of a snapshot
    pub meta: SnapshotMeta<CLID, NID, N>,

    /// A read handle to the associated snapshot.
    pub snapshot: SD,
}

impl<CLID, NID, N, SD> Snapshot<CLID, NID, N, SD>
where
    CLID: RaftCommittedLeaderId,
    NID: NodeId,
    N: Node,
    SD: OptionalSend + 'static,
{
    #[allow(dead_code)]
    pub(crate) fn new(meta: SnapshotMeta<CLID, NID, N>, snapshot: SD) -> Self {
        Self { meta, snapshot }
    }
}

impl<CLID, NID, N, SD> fmt::Display for Snapshot<CLID, NID, N, SD>
where
    CLID: RaftCommittedLeaderId,
    NID: NodeId,
    N: Node,
    SD: OptionalSend + 'static,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Snapshot{{meta: {}}}", self.meta)
    }
}