harmos-runtime 0.1.5

Harmos runtime: managed state, undo, recovery, background work and typed streams.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

/* === Modules === */

/* === Re-Exports === */

/* === Imports === */

// Standard Library Imports
use std::future::Future;
use std::path::PathBuf;
use std::pin::Pin;
use std::time::Duration;
// Third Party Imports

// Local Imports
use super::EvidenceError;

/* === Constants === */

/* === Macros === */

/* === Type Aliases === */

pub(crate) type Answering<'a, T> = Pin<Box<dyn Future<Output = Result<T, EvidenceError>> + Send + 'a>>;

/* === Structs === */

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Excerpt {
    pub requested: u64,
    pub offset: u64,
    pub bytes: Vec<u8>,
    pub length: u64,
}

/* === Enums === */

/* === Traits === */

pub trait Vault: Send + Sync + 'static {
    fn ceiling(&self) -> usize;

    fn cadence(&self) -> Duration;

    fn open(&self, name: &str) -> impl Future<Output = Result<u64, EvidenceError>> + Send;

    fn external(&self, name: &str) -> impl Future<Output = Result<Option<PathBuf>, EvidenceError>> + Send;

    fn append(&self, name: &str, bytes: &[u8]) -> impl Future<Output = Result<u64, EvidenceError>> + Send;

    fn length(&self, name: &str) -> impl Future<Output = Result<u64, EvidenceError>> + Send;

    fn verify(&self, name: &str) -> impl Future<Output = Result<(u64, u64), EvidenceError>> + Send;

    fn claim(&self, name: &str) -> impl Future<Output = Result<(), EvidenceError>> + Send;

    fn quarantine(&self, name: &str) -> impl Future<Output = Result<(), EvidenceError>> + Send;

    fn read(&self, name: &str, offset: u64, limit: usize) -> impl Future<Output = Result<(Vec<u8>, u64), EvidenceError>> + Send;

    fn read_draft(&self, name: &str, offset: u64, limit: usize) -> impl Future<Output = Result<(Vec<u8>, u64), EvidenceError>> + Send;
}

pub(crate) trait Keeping: Send + Sync + 'static {
    fn ceiling(&self) -> usize;

    fn cadence(&self) -> Duration;

    fn open<'a>(&'a self, name: &'a str) -> Answering<'a, u64>;

    fn external<'a>(&'a self, name: &'a str) -> Answering<'a, Option<PathBuf>>;

    fn append<'a>(&'a self, name: &'a str, bytes: &'a [u8]) -> Answering<'a, u64>;

    fn length<'a>(&'a self, name: &'a str) -> Answering<'a, u64>;

    fn verify<'a>(&'a self, name: &'a str) -> Answering<'a, (u64, u64)>;

    fn claim<'a>(&'a self, name: &'a str) -> Answering<'a, ()>;

    fn quarantine<'a>(&'a self, name: &'a str) -> Answering<'a, ()>;

    fn read<'a>(&'a self, name: &'a str, offset: u64, limit: usize) -> Answering<'a, (Vec<u8>, u64)>;

    fn read_draft<'a>(&'a self, name: &'a str, offset: u64, limit: usize) -> Answering<'a, (Vec<u8>, u64)>;
}

/* === Implementations === */

impl Excerpt {
    pub fn next(&self) -> u64 {
        self.offset + self.bytes.len() as u64
    }
}

impl<V: Vault> Keeping for V {
    fn ceiling(&self) -> usize {
        Vault::ceiling(self)
    }

    fn cadence(&self) -> Duration {
        Vault::cadence(self)
    }

    fn open<'a>(&'a self, name: &'a str) -> Answering<'a, u64> {
        Box::pin(Vault::open(self, name))
    }

    fn external<'a>(&'a self, name: &'a str) -> Answering<'a, Option<PathBuf>> {
        Box::pin(Vault::external(self, name))
    }

    fn append<'a>(&'a self, name: &'a str, bytes: &'a [u8]) -> Answering<'a, u64> {
        Box::pin(Vault::append(self, name, bytes))
    }

    fn length<'a>(&'a self, name: &'a str) -> Answering<'a, u64> {
        Box::pin(Vault::length(self, name))
    }

    fn verify<'a>(&'a self, name: &'a str) -> Answering<'a, (u64, u64)> {
        Box::pin(Vault::verify(self, name))
    }

    fn claim<'a>(&'a self, name: &'a str) -> Answering<'a, ()> {
        Box::pin(Vault::claim(self, name))
    }

    fn quarantine<'a>(&'a self, name: &'a str) -> Answering<'a, ()> {
        Box::pin(Vault::quarantine(self, name))
    }

    fn read<'a>(&'a self, name: &'a str, offset: u64, limit: usize) -> Answering<'a, (Vec<u8>, u64)> {
        Box::pin(Vault::read(self, name, offset, limit))
    }

    fn read_draft<'a>(&'a self, name: &'a str, offset: u64, limit: usize) -> Answering<'a, (Vec<u8>, u64)> {
        Box::pin(Vault::read_draft(self, name, offset, limit))
    }
}

/* === Public Functions === */

/* === Private Functions === */

/* === Tests === */