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

//! Events represent changes to accounts, folders and files.
//!
//! Events may be appended to *event log* files for persistence.
//!
//! Event logs maintain an in-memory merkle tree of commits to
//! enable syncing of data between devices.
//!
//! They are also used for some read events to maintain
//! an audit trail of actions.

mod account;
mod change;
mod device;
mod event;
mod event_kind;
mod event_log;
#[cfg(feature = "files")]
mod file;
pub mod patch;
mod read;
mod record;
mod write;

pub use account::AccountEvent;
pub use change::{changes_feed, LocalChangeEvent};
pub use device::DeviceEvent;
pub use event::Event;
pub use event_kind::EventKind;
pub use event_log::EventLog;
#[cfg(feature = "files")]
pub use file::FileEvent;
pub use read::ReadEvent;
pub use record::EventRecord;
pub use write::WriteEvent;

use serde::{Deserialize, Serialize};

/// Types of event logs.
#[derive(Serialize, Deserialize, Debug, Copy, Clone, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum EventLogType {
    /// Identity folder event log.
    Identity,
    /// Account event log.
    Account,
    /// Device event log.
    Device,
    /// Files event log.
    #[cfg(feature = "files")]
    Files,
    /// Folder event log.
    Folder(crate::VaultId),
}

/// Trait for events that can be written to an event log.
pub trait LogEvent {
    /// Get the event kind for this event.
    fn event_kind(&self) -> EventKind;
}