p2panda-store 0.6.1

Database traits and SQLite implementations for p2panda
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

// SPDX-License-Identifier: MIT OR Apache-2.0

use std::{collections::BTreeMap, error::Error};

type LogEntries<T> = Vec<(T, Vec<u8>)>;

/// Store methods for aiding efficient comparison of log-based data types.
///
/// The concrete message type contained on each log "entry" is not known in this API. It is
/// assumed there is another store for retrieving these during sync (eg. OperationStore).
pub trait LogStore<T, A, L, S, ID> {
    type Error: Error;

    /// Get the latest entry in a log.
    ///
    /// Returns None when the author or a log with the requested id was not found.
    fn get_latest_entry(
        &self,
        author: &A,
        log_id: &L,
    ) -> impl Future<Output = Result<Option<T>, Self::Error>>;

    /// Get the ID and sequence number of the latest entry in a log.
    ///
    /// This method must be called within the context of a transaction. Failure to do so will
    /// result in an error. See the documentation for the `Transaction` trait and the
    /// corresponding implementation for `SqliteStore` to learn more.
    ///
    /// Returns None when the author or a log with the requested id was not found.
    fn get_latest_entry_tx(
        &self,
        author: &A,
        log_id: &L,
    ) -> impl Future<Output = Result<Option<T>, Self::Error>>;

    /// Get current heights for a set of logs.
    ///
    /// Returns the sequence number for the latest entry in every requested log.
    ///
    /// Returns None when the author or a log with the requested id was not found.
    fn get_log_heights(
        &self,
        author: &A,
        logs: &[L],
    ) -> impl Future<Output = Result<Option<BTreeMap<L, S>>, Self::Error>>;

    /// Get the byte and operation count of the entries in a log.
    ///
    /// `after` and `until` fields can be provided to select only a range of the log.
    fn get_log_size(
        &self,
        author: &A,
        log_id: &L,
        after: Option<S>,
        until: Option<S>,
    ) -> impl Future<Output = Result<Option<(u64, u64)>, Self::Error>>;

    /// Get all entries in a log after an optional starting point.
    ///
    /// `after` and `to` fields can be provided to select only a range of the log.
    fn get_log_entries(
        &self,
        author: &A,
        log_id: &L,
        after: Option<S>,
        until: Option<S>,
    ) -> impl Future<Output = Result<Option<LogEntries<T>>, Self::Error>>;

    /// Prune all entries in a log until the provided sequence number.
    ///
    /// Returns the number of entries which were pruned.
    fn prune_entries(
        &self,
        author: &A,
        log_id: &L,
        until: &S,
    ) -> impl Future<Output = Result<u64, Self::Error>>;
}