commonware-storage 2026.4.0

Persist and retrieve data from an abstract store.
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

//! Type-state for operations with fixed or variable size.

use commonware_codec::{CodecFixedShared, CodecShared};
use std::marker::PhantomData;

mod sealed {
    use commonware_codec::CodecShared;

    /// A wrapper around a value to indicate whether it is fixed or variable size.
    /// Having separate wrappers for fixed and variable size values allows us to use the same
    /// operation type for both fixed and variable size values, while still being able to
    /// parameterize the operation encoding by the value type.
    pub trait ValueEncoding: Clone + Send + Sync {
        /// The wrapped value type.
        type Value: CodecShared + Clone;
    }
}

pub use sealed::ValueEncoding;

/// A fixed-size, clonable value.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct FixedEncoding<V: FixedValue>(PhantomData<V>);

impl<V: FixedValue> sealed::ValueEncoding for FixedEncoding<V> {
    type Value = V;
}

/// A variable-size, clonable value.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct VariableEncoding<V: VariableValue>(PhantomData<V>);

impl<V: VariableValue> sealed::ValueEncoding for VariableEncoding<V> {
    type Value = V;
}

/// A fixed-size, clonable value.
pub trait FixedValue: CodecFixedShared + Clone {}
impl<T: CodecFixedShared + Clone> FixedValue for T {}

/// A variable-size, clonable value.
pub trait VariableValue: CodecShared + Clone {}
impl<T: CodecShared + Clone> VariableValue for T {}