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
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

use crate::qmdb::{
    any::{
        operation::{update::sealed::Sealed, Update as UpdateTrait},
        value::{FixedEncoding, ValueEncoding, VariableEncoding},
        FixedValue, VariableValue,
    },
    operation::Key,
};
use commonware_codec::{
    Encode as _, EncodeSize, Error as CodecError, FixedSize, Read, ReadExt as _, Write,
};
use commonware_runtime::{Buf, BufMut};
use commonware_utils::{hex, Array};
use std::fmt;

#[derive(Clone, PartialEq, Debug, Eq)]
pub struct Update<K: Key, V: ValueEncoding> {
    pub key: K,
    pub value: V::Value,
    pub next_key: K,
}

#[cfg(feature = "arbitrary")]
impl<K: Key, V: ValueEncoding> arbitrary::Arbitrary<'_> for Update<K, V>
where
    K: for<'a> arbitrary::Arbitrary<'a>,
    V::Value: for<'a> arbitrary::Arbitrary<'a>,
{
    fn arbitrary(u: &mut arbitrary::Unstructured<'_>) -> arbitrary::Result<Self> {
        Ok(Self {
            key: u.arbitrary()?,
            value: u.arbitrary()?,
            next_key: u.arbitrary()?,
        })
    }
}

impl<K: Key, V: ValueEncoding> Sealed for Update<K, V> {}

impl<K: Key, V: ValueEncoding> UpdateTrait for Update<K, V> {
    type Key = K;
    type Value = V::Value;
    type ValueEncoding = V;

    fn key(&self) -> &K {
        &self.key
    }

    fn value(&self) -> &V::Value {
        &self.value
    }

    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "[key:{} next_key:{} value:{}]",
            hex(&self.key),
            hex(&self.next_key),
            hex(&self.value.encode())
        )
    }
}

impl<K: Array, V: FixedValue> FixedSize for Update<K, FixedEncoding<V>> {
    const SIZE: usize = K::SIZE + V::SIZE + K::SIZE;
}

impl<K, V> Write for Update<K, V>
where
    K: Key + Write,
    V: ValueEncoding,
    V::Value: Write,
{
    fn write(&self, buf: &mut impl BufMut) {
        self.key.write(buf);
        self.value.write(buf);
        self.next_key.write(buf);
    }
}

impl<K: Array, V: FixedValue> Read for Update<K, FixedEncoding<V>> {
    type Cfg = ();

    fn read_cfg(buf: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, CodecError> {
        let key = K::read(buf)?;
        let value = V::read_cfg(buf, cfg)?;
        let next_key = K::read(buf)?;
        Ok(Self {
            key,
            value,
            next_key,
        })
    }
}

impl<K, V> EncodeSize for Update<K, VariableEncoding<V>>
where
    K: Key + EncodeSize,
    V: VariableValue,
{
    fn encode_size(&self) -> usize {
        self.key.encode_size() + self.value.encode_size() + self.next_key.encode_size()
    }
}

impl<K, V> Read for Update<K, VariableEncoding<V>>
where
    K: Key + Read,
    V: VariableValue,
{
    type Cfg = (<K as Read>::Cfg, <V as Read>::Cfg);

    fn read_cfg(buf: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, CodecError> {
        let key = K::read_cfg(buf, &cfg.0)?;
        let value = V::read_cfg(buf, &cfg.1)?;
        let next_key = K::read_cfg(buf, &cfg.0)?;
        Ok(Self {
            key,
            value,
            next_key,
        })
    }
}