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

use crate::{commit::CommitSpan, events::EventLogType, AccountId};
use serde::{Deserialize, Serialize};
use std::sync::OnceLock;
use tokio::sync::watch;

static CHANGES_FEED: OnceLock<watch::Sender<LocalChangeEvent>> =
    OnceLock::new();

/// Change event.
///
/// Used for IPC communication when a process needs
/// to know if changes have been made externally,
///
/// For example, the browser extension helper executable
/// can detect changes made by the app and update it's
/// view.
#[derive(Serialize, Deserialize, Default, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub enum LocalChangeEvent {
    /// Changes feed was initialized.
    #[default]
    Init,
    /// Account was created.
    AccountCreated(AccountId),
    /// Account was modified.
    AccountModified {
        /// Account identifier.
        account_id: AccountId,
        /// Type of the event log.
        log_type: EventLogType,
        /// Span of commit hashes.
        commit_span: CommitSpan,
    },
    /// Account was deleted.
    AccountDeleted(AccountId),
}

/// Feed of change events.
pub fn changes_feed<'a>() -> &'a watch::Sender<LocalChangeEvent> {
    CHANGES_FEED.get_or_init(|| {
        let (tx, _) = watch::channel(LocalChangeEvent::default());
        tx
    })
}