commonware-storage 2026.10.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

//! Fixed-size retained bytes for checking storage decode ownership.

use bytes::{BufMut, Bytes};
use commonware_codec::{Buf, Error, FixedSize, Read, Write, util::at_least};

/// A fixed-size byte view for checking shared decoding.
#[derive(Clone, Debug)]
pub(crate) struct View {
    pub(crate) bytes: Bytes,
    source: usize,
}

impl View {
    pub(crate) fn new(value: u64) -> Self {
        Self {
            bytes: Bytes::copy_from_slice(&value.to_be_bytes()),
            source: 0,
        }
    }

    pub(crate) fn assert_shared(&self) {
        assert_eq!(self.bytes.as_ptr() as usize, self.source);
    }
}

impl FixedSize for View {
    const SIZE: usize = u64::SIZE;
}

impl Write for View {
    fn write(&self, buf: &mut impl BufMut) {
        buf.put_slice(&self.bytes);
    }
}

impl Read for View {
    type Cfg = ();

    fn read_cfg(buf: &mut impl Buf, _: &()) -> Result<Self, Error> {
        at_least(buf, Self::SIZE)?;
        let source = buf.chunk().as_ptr() as usize;
        Ok(Self {
            bytes: buf.copy_to_bytes(Self::SIZE),
            source,
        })
    }
}