harmos-domain 0.1.5

Harmos domain model: identifiers, contracts, catalogs and storage identities.
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

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports

// Third Party Imports

// Local Imports
use super::{ArrowIpc, SchemaKey, StorageCursor};
use crate::{Identifier, MemorySize};

/* === Constants === */

/* === Macros === */

crate::model::storage::codec::product!(DataBatch {
    sequence: crate::model::storage::codec::Unsigned => 1,
    destination: crate::model::storage::codec::Id => 2,
    schema: crate::model::storage::codec::Nested<SchemaKey> => 3,
    data: crate::model::storage::codec::Nested<ArrowIpc> => 4,
});
crate::model::storage::codec::product!(BatchReceipt {
    sequence: crate::model::storage::codec::Unsigned => 1,
    cursor: crate::model::storage::codec::Nested<StorageCursor> => 2,
});
crate::model::storage::codec::product!(WriteCompletion {
    batches: crate::model::storage::codec::Unsigned => 1,
    cursor: crate::model::storage::codec::Nested<StorageCursor> => 2,
});
crate::model::storage::codec::variants!(WriteReceipt {
    0, 1, "accepted": Self::Accepted(receipt) => {
        receipt: crate::model::storage::codec::Nested<BatchReceipt> => 1,
    } => Self::Accepted(receipt);
    1, 2, "durable": Self::Durable(receipt) => {
        receipt: crate::model::storage::codec::Nested<BatchReceipt> => 1,
    } => Self::Durable(receipt);
});

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

/* === Structs === */

#[derive(Clone, Debug)]
pub struct DataBatch {
    pub sequence: u64,
    pub destination: Identifier,
    pub schema: SchemaKey,
    pub data: ArrowIpc,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct BatchReceipt {
    pub sequence: u64,
    pub cursor: StorageCursor,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct WriteCompletion {
    pub batches: u64,
    pub cursor: StorageCursor,
}

/* === Enums === */

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum WriteReceipt {
    Accepted(BatchReceipt),
    Durable(BatchReceipt),
}

/* === Traits === */

/* === Implementations === */

impl MemorySize for DataBatch {
    fn memory_size(&self) -> usize {
        std::mem::size_of::<Self>()
            .saturating_add(self.destination.memory_size().saturating_sub(std::mem::size_of_val(&self.destination)))
            .saturating_add(self.schema.memory_size().saturating_sub(std::mem::size_of_val(&self.schema)))
            .saturating_add(self.data.memory_size().saturating_sub(std::mem::size_of_val(&self.data)))
    }
}

impl MemorySize for BatchReceipt {
    fn memory_size(&self) -> usize {
        std::mem::size_of::<Self>().saturating_add(self.cursor.memory_size().saturating_sub(std::mem::size_of_val(&self.cursor)))
    }
}

impl MemorySize for WriteReceipt {
    fn memory_size(&self) -> usize {
        let receipt = match self {
            Self::Accepted(receipt) | Self::Durable(receipt) => receipt,
        };
        std::mem::size_of::<Self>().saturating_add(receipt.memory_size().saturating_sub(std::mem::size_of::<BatchReceipt>()))
    }
}

impl MemorySize for WriteCompletion {
    fn memory_size(&self) -> usize {
        std::mem::size_of::<Self>().saturating_add(self.cursor.memory_size().saturating_sub(std::mem::size_of_val(&self.cursor)))
    }
}

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

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

/* === Tests === */