sos-core 0.17.3

Core types for the Save Our Secrets SDK
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

use crate::{
    commit::{CommitHash, CommitTree},
    decode, encode, Result, UtcDateTime,
};
use binary_stream::futures::{Decodable, Encodable};

/// Record for a row in an event log.
#[derive(Default, Debug, Clone, Eq, PartialEq)]
pub struct EventRecord(
    pub(crate) UtcDateTime,
    pub(crate) CommitHash,
    pub(crate) CommitHash,
    pub(crate) Vec<u8>,
);

impl EventRecord {
    /// Create an event record.
    pub fn new(
        time: UtcDateTime,
        last_commit: CommitHash,
        commit: CommitHash,
        event: Vec<u8>,
    ) -> Self {
        Self(time, last_commit, commit, event)
    }

    /// Date and time the record was created.
    pub fn time(&self) -> &UtcDateTime {
        &self.0
    }

    /// Set the record time.
    pub fn set_time(&mut self, time: UtcDateTime) {
        self.0 = time;
    }

    /// Last commit hash for the record.
    pub fn last_commit(&self) -> &CommitHash {
        &self.1
    }

    /// Set last commit hash for the record.
    pub fn set_last_commit(&mut self, commit: Option<CommitHash>) {
        self.1 = commit.unwrap_or_default();
    }

    /// Commit hash for the record.
    pub fn commit(&self) -> &CommitHash {
        &self.2
    }

    /// Record event bytes.
    pub fn event_bytes(&self) -> &[u8] {
        self.3.as_slice()
    }

    /// Size of the event buffer.
    pub fn size(&self) -> usize {
        self.3.len()
    }

    /// Decode this event record.
    pub async fn decode_event<T: Default + Decodable>(&self) -> Result<T> {
        Ok(decode(&self.3).await?)
    }

    /// Encode an event into an event record.
    ///
    /// Encodes using a zero last commit and now
    /// as the date time.
    pub async fn encode_event<T: Default + Encodable>(
        event: &T,
    ) -> Result<Self> {
        let bytes = encode(event).await?;
        let commit = CommitHash(CommitTree::hash(&bytes));
        Ok(EventRecord(
            Default::default(),
            Default::default(),
            commit,
            bytes,
        ))
    }
}

impl From<EventRecord> for (UtcDateTime, CommitHash, CommitHash, Vec<u8>) {
    fn from(value: EventRecord) -> Self {
        (value.0, value.1, value.2, value.3)
    }
}