harmos-storage 0.1.7

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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

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

/* === Modules === */

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

/* === Imports === */

// Standard Library Imports
use std::borrow::Borrow;
use std::ops::Deref;
use std::sync::Arc;
// Third Party Imports
// Local Imports
use crate::MemorySize;

/* === Constants === */

/* === Macros === */

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

/// A retained collection of original typed row pages.
pub type ReadPages<T> = ReadBatch<Vec<ReadBatch<Vec<T>>>>;

/* === Structs === */

pub struct ReadBatch<T> {
    inner: Arc<ReadOwner<T>>,
}

struct ReadOwner<T> {
    value: T,
}

/* === Enums === */

/* === Traits === */

/* === Implementations === */

impl<T> ReadBatch<T> {
    pub fn new(value: T) -> Self {
        Self { inner: Arc::new(ReadOwner { value }) }
    }

    /// Moves A Unique Batch Through A Fallible Projection.
    #[tracing::instrument(name = "storage.read_batch.try_map", level = "trace", skip_all, fields(outcome = "cancelled"))]
    pub fn try_map<U, E>(self, map: impl FnOnce(T) -> std::result::Result<U, E>) -> std::result::Result<ReadBatch<U>, E>
    where
        E: From<crate::Error>,
    {
        let owner = Arc::try_unwrap(self.inner).map_err(|_| {
            E::from(crate::Error::InvalidInput {
                field: "read projection",
                reason: "requires a unique owner",
            })
        })?;
        let value = map(owner.value)?;
        tracing::Span::current().record("outcome", "completed");
        Ok(ReadBatch::new(value))
    }

    pub fn try_map_with<U, V, E>(
        self, other: ReadBatch<U>, map: impl FnOnce(T, U) -> std::result::Result<V, E>,
    ) -> std::result::Result<ReadBatch<V>, E>
    where
        E: From<crate::Error>,
    {
        let shared = || {
            E::from(crate::Error::InvalidInput {
                field: "read projection",
                reason: "requires unique owners",
            })
        };
        let left = Arc::try_unwrap(self.inner).map_err(|_| shared())?;
        let right = Arc::try_unwrap(other.inner).map_err(|_| shared())?;
        Ok(ReadBatch::new(map(left.value, right.value)?))
    }

    pub fn owner(&self) -> Arc<impl Borrow<T> + Send + Sync + 'static>
    where
        T: Send + Sync + 'static,
    {
        Arc::clone(&self.inner)
    }
}

impl<T: std::fmt::Debug> std::fmt::Debug for ReadBatch<T> {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.debug_tuple("ReadBatch").field(&self.inner.value).finish()
    }
}

impl<T> Clone for ReadBatch<T> {
    fn clone(&self) -> Self {
        Self { inner: Arc::clone(&self.inner) }
    }
}

impl<T> Deref for ReadBatch<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.inner.value
    }
}

impl<T> AsRef<T> for ReadBatch<T> {
    fn as_ref(&self) -> &T {
        &self.inner.value
    }
}

impl<T> Borrow<T> for ReadOwner<T> {
    fn borrow(&self) -> &T {
        &self.value
    }
}

impl<T: MemorySize> MemorySize for ReadBatch<T> {
    fn memory_size(&self) -> usize {
        std::mem::size_of::<Self>()
            .saturating_add(std::mem::size_of::<ReadOwner<T>>())
            .saturating_add(2 * std::mem::size_of::<usize>())
            .saturating_add(self.inner.value.memory_size().saturating_sub(std::mem::size_of::<T>()))
    }
}

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

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

/* === Tests === */

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn shared_projection_preserves_payload() {
        let bytes = vec![1u8, 2, 3];
        let pointer = bytes.as_ptr();
        let batch = ReadBatch::new(bytes);
        let alias = batch.clone();
        assert!(batch.try_map(Ok::<_, crate::Error>).is_err());
        assert_eq!(alias.as_ptr(), pointer);
        let projected = alias.try_map(|bytes| Ok::<_, crate::Error>(vec![bytes])).unwrap();
        assert_eq!(projected[0].as_ptr(), pointer);
        assert_eq!(projected[0], [1, 2, 3]);
    }
}