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

//! Shared sync types and functionality for authenticated databases.

use crate::qmdb::sync::engine::Config;
use commonware_codec::Encode;

pub mod engine;
pub(crate) use engine::Engine;

mod error;
pub use error::{EngineError, Error};

mod gaps;
mod journal;

pub(crate) use journal::Journal;

mod database;
pub(crate) use database::{Config as DatabaseConfig, Database};

pub mod resolver;
pub(crate) use resolver::{FetchResult, Resolver};

mod target;
pub use target::Target;

mod requests;

/// Create/open a database and sync it to a target state
pub async fn sync<DB, R>(config: Config<DB, R>) -> Result<DB, Error<R::Error, DB::Digest>>
where
    DB: Database,
    DB::Op: Encode,
    R: resolver::Resolver<Op = DB::Op, Digest = DB::Digest>,
{
    Engine::new(config).await?.sync().await
}