commonware-storage 2026.7.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
124
125
126
127
128
129
130
131
132
133
134
135
136

//! Persist and retrieve data from an abstract store.
//!
//! # Status
//!
//! Stability varies by primitive. See [README](https://github.com/commonwarexyz/monorepo#stability) for details.

#![doc(
    html_logo_url = "https://commonware.xyz/imgs/rustdoc_logo.svg",
    html_favicon_url = "https://commonware.xyz/favicon.ico"
)]
#![cfg_attr(not(any(feature = "std", test)), no_std)]

commonware_macros::stability_scope!(ALPHA {
    extern crate alloc;

    pub mod bmt;
    pub mod merkle;
    pub use merkle::{mmb, mmr};
});
commonware_macros::stability_scope!(ALPHA, cfg(feature = "std") {
    mod bitmap;
    pub mod qmdb;
    pub use crate::bitmap::{BitMap as AuthenticatedBitMap, MerkleizedBitMap, UnmerkleizedBitMap};
    pub mod cache;
    pub mod queue;
    #[cfg(any(test, feature = "test-utils"))]
    pub mod utils;
});
commonware_macros::stability_scope!(BETA, cfg(feature = "std") {
    pub mod archive;
    pub mod freezer;
    pub mod index;
    pub mod journal;
    pub mod metadata;
    pub mod ordinal;
    pub mod rmap;

    /// Section selector for storage operations that act on one or more sections.
    pub trait Sections {
        /// Iterator over selected sections.
        type Iter: Iterator<Item = u64>;

        /// Convert into selected section indices.
        ///
        /// This trait does not impose ordering or uniqueness; each storage operation decides how
        /// to handle duplicates and missing sections.
        fn sections(self) -> Self::Iter;
    }

    impl Sections for u64 {
        type Iter = core::iter::Once<Self>;

        fn sections(self) -> Self::Iter {
            core::iter::once(self)
        }
    }

    impl<const N: usize> Sections for [u64; N] {
        type Iter = core::array::IntoIter<u64, N>;

        fn sections(self) -> Self::Iter {
            self.into_iter()
        }
    }

    impl<'a, const N: usize> Sections for &'a [u64; N] {
        type Iter = core::iter::Copied<core::slice::Iter<'a, u64>>;

        fn sections(self) -> Self::Iter {
            self.iter().copied()
        }
    }

    impl<'a> Sections for &'a [u64] {
        type Iter = core::iter::Copied<core::slice::Iter<'a, u64>>;

        fn sections(self) -> Self::Iter {
            self.iter().copied()
        }
    }

    impl Sections for Vec<u64> {
        type Iter = std::vec::IntoIter<u64>;

        fn sections(self) -> Self::Iter {
            self.into_iter()
        }
    }

    impl<'a> Sections for &'a Vec<u64> {
        type Iter = core::iter::Copied<core::slice::Iter<'a, u64>>;

        fn sections(self) -> Self::Iter {
            self.iter().copied()
        }
    }

    impl Sections for std::collections::BTreeSet<u64> {
        type Iter = std::collections::btree_set::IntoIter<u64>;

        fn sections(self) -> Self::Iter {
            self.into_iter()
        }
    }

    impl<'a> Sections for &'a std::collections::BTreeSet<u64> {
        type Iter = core::iter::Copied<std::collections::btree_set::Iter<'a, u64>>;

        fn sections(self) -> Self::Iter {
            self.iter().copied()
        }
    }

    /// A runtime context providing storage, timing, and metrics capabilities.
    ///
    /// This is a convenience alias for the trait bound `BufferPooler + Storage + Clock + Metrics`
    /// that appears on nearly every type in this crate.
    pub trait Context:
        commonware_runtime::BufferPooler
        + commonware_runtime::Storage
        + commonware_runtime::Clock
        + commonware_runtime::Metrics
    {
    }
    impl<
            T: commonware_runtime::BufferPooler
                + commonware_runtime::Storage
                + commonware_runtime::Clock
                + commonware_runtime::Metrics,
        > Context for T
    {
    }
});
commonware_macros::stability_scope!(BETA {
    pub mod translator;
});