guardian-db 0.19.0

High-performance, local-first decentralized database built on Rust and Iroh
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
90
91
92
93
94

use crate::log::access_control::LogEntry;
use crate::log::identity::Identity;
use crate::log::identity_provider::IdentityProvider;
use crate::p2p::network::client::IrohClient;
use iroh_blobs::Hash;
use std::collections::HashMap;

/// Trait representing an entry in the iroh log.
pub trait IrohLogEntry: LogEntry {
    fn new() -> Self
    where
        Self: Sized;
    fn copy(&self) -> Self
    where
        Self: Sized;
    fn get_log_id(&self) -> String;
    fn get_next(&self) -> Vec<Hash>;
    fn get_refs(&self) -> Vec<Hash>;
    fn get_v(&self) -> u64;
    fn get_key(&self) -> Vec<u8>;
    fn get_sig(&self) -> Vec<u8>;
    fn get_hash(&self) -> Hash;
    fn get_clock(&self) -> Box<dyn IrohLogLamportClock>;
    fn get_additional_data(&self) -> HashMap<String, String>;
    fn set_payload(&mut self, payload: Vec<u8>);
    fn set_log_id(&mut self, id: String);
    fn set_next(&mut self, next: Vec<Hash>);
    fn set_refs(&mut self, refs: Vec<Hash>);
    fn set_v(&mut self, v: u64);
    fn set_key(&mut self, key: Vec<u8>);
    fn set_sig(&mut self, sig: Vec<u8>);
    fn set_identity(&mut self, identity: Identity);
    fn set_hash(&mut self, hash: Hash);
    fn set_clock(&mut self, clock: Box<dyn IrohLogLamportClock>);
    fn set_additional_data_value(&mut self, key: String, value: String);
    fn is_valid(&self) -> bool;
    fn verify(
        &self,
        identity: &dyn IdentityProvider,
        io: &dyn IO,
    ) -> std::result::Result<(), String>;
    fn equals(&self, b: &dyn IrohLogEntry) -> bool;
    fn is_parent(&self, b: &dyn IrohLogEntry) -> bool;
    fn defined(&self) -> bool;
}

/// Trait representing a Lamport clock for the iroh Log.
pub trait IrohLogLamportClock {
    fn new() -> Self
    where
        Self: Sized;
    fn defined(&self) -> bool;

    fn get_id(&self) -> Vec<u8>;
    fn get_time(&self) -> i32;

    fn set_id(&mut self, id: Vec<u8>);
    fn set_time(&mut self, time: i32);

    fn tick(&mut self) -> Self
    where
        Self: Sized;
    fn merge(&mut self, clock: &dyn IrohLogLamportClock) -> Self
    where
        Self: Sized;
    fn compare(&self, b: &dyn IrohLogLamportClock) -> i32;
}

/// Trait abstracting IO operations over iroh.
pub trait IO {
    fn write(
        &self,
        iroh: &IrohClient,
        obj: &dyn std::any::Any,
        opts: Option<&WriteOpts>,
    ) -> std::result::Result<Hash, String>;

    fn read(&self, iroh: &IrohClient, hash: Hash) -> std::result::Result<Vec<u8>, String>;
}

/// Represents a log in JSON format.
#[derive(Debug, Clone)]
pub struct JSONLog {
    pub id: String,
    pub heads: Vec<Hash>,
}

/// Options for writing to the Log.
#[derive(Debug, Clone)]
pub struct WriteOpts {
    pub pin: bool,
    pub encrypted_links: Option<String>,
    pub encrypted_links_nonce: Option<String>,
}