harmos-storage 0.1.2

Harmos storage: durable journals, snapshots and Arrow-backed stream storage.
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

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports
use std::f64::consts::TAU;
use std::num::NonZeroU32;
use std::time::{Duration, UNIX_EPOCH};

// Third Party Imports
use harmos_domain::{DefinitionId, Identified, Identifier, Message};
use harmos_storage::*;

// Local Imports

/* === Constants === */

pub const AMPLITUDE: f64 = 12.0;
pub const SAMPLES_PER_PERIOD: usize = 64;
/* === Macros === */

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

/* === Structs === */

#[harmos_domain::message]
#[derive(Clone, Debug, PartialEq)]
pub struct Sample {
    pub phase: u32,
    pub ordinal: u64,
    pub value: f64,
}

#[harmos_domain::message]
#[derive(Clone, Debug, PartialEq)]
pub struct Experiment {
    pub id: String,
    pub label: String,
}

/* === Enums === */

#[harmos_domain::catalog]
pub enum Objects {
    Experiment(Experiment),
}
/* === Traits === */

/* === Implementations === */

impl Identified for Experiment {
    fn definition() -> (DefinitionId, u32) {
        (DefinitionId::new("storage.experiment"), 1)
    }
}
impl StoredObject for Experiment {
    type Key = String;
    const RETENTION: ObjectRetention = ObjectRetention::UntilReleased;
    fn key(&self) -> &String {
        &self.id
    }
}
/* === Public Functions === */

pub fn schema() -> SchemaKey {
    SchemaKey {
        id: Identifier::new("storage.waveform").unwrap(),
        version: NonZeroU32::new(1).unwrap(),
        payload_encoding: PayloadEncoding::PostcardV1,
    }
}

pub fn definition() -> harmos_domain::schema::graph::Schema {
    use harmos_domain::schema::Cardinality;
    use harmos_domain::schema::graph::{Field, Kind};
    harmos_domain::schema::graph::Schema {
        root: 0,
        definitions: vec![vec![
            Field { name: "phase".into(), tag: 1, kind: Kind::U32, cardinality: Cardinality::Required },
            Field { name: "ordinal".into(), tag: 2, kind: Kind::U64, cardinality: Cardinality::Required },
            Field { name: "value".into(), tag: 3, kind: Kind::F64, cardinality: Cardinality::Required },
        ]],
    }
}

pub fn samples(periods: usize) -> Vec<Sample> {
    (0..periods * SAMPLES_PER_PERIOD)
        .flat_map(|ordinal| {
            (0..3).map(move |phase| {
                let angle = TAU * ordinal as f64 / SAMPLES_PER_PERIOD as f64 - TAU * phase as f64 / 3.0;
                Sample { phase, ordinal: ordinal as u64, value: AMPLITUDE * angle.sin() }
            })
        })
        .collect()
}

pub fn inputs(samples: &[Sample]) -> Vec<StreamInput> {
    let schema = schema();
    samples
        .iter()
        .map(|sample| StreamInput {
            record: RecordInput {
                schema: schema.clone(),
                scope: Some(Identifier::new("experiment").unwrap()),
                item: Identifier::new(format!("phase-{}", sample.phase)).unwrap(),
                source: None,
                source_time: Some(UNIX_EPOCH + Duration::from_millis(sample.ordinal)),
                payload: Message::encode_to_vec(sample),
            },
            stream: Identifier::new(format!("phase-{}", sample.phase)).unwrap(),
            sequence: sample.ordinal,
        })
        .collect()
}

pub fn binary(length: usize) -> Vec<u8> {
    (0..length).map(|index| ((index * 37 + 11) % 251) as u8).collect()
}
/* === Private Functions === */

/* === Tests === */