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

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

use std::error::Error;

/// Interface for storing, deleting and querying operations.
///
/// The concrete type of an "operation" is generic and implementors can use the same interface for
/// different approaches: sets, append-only logs, hash-graphs (DAG) etc.
pub trait OperationStore<T, ID, C> {
    type Error: Error;

    /// Insert an operation.
    ///
    /// Returns `true` when the insert occurred, or `false` when the operation already existed and
    /// no insertion occurred.
    fn insert_operation(
        &self,
        id: &ID,
        operation: &T,
        collection_id: &C,
    ) -> impl Future<Output = Result<bool, Self::Error>>;

    /// Get an operation by id.
    fn get_operation(&self, id: &ID) -> impl Future<Output = Result<Option<T>, Self::Error>>;

    /// Get an operation by id.
    ///
    /// 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.
    fn get_operation_tx(&self, id: &ID) -> impl Future<Output = Result<Option<T>, Self::Error>>;

    /// Query the existence of an operation.
    ///
    /// Returns `true` if the operation was found in the store and `false` if not.
    fn has_operation(&self, id: &ID) -> impl Future<Output = Result<bool, Self::Error>>;

    /// Query the existence of an operation.
    ///
    /// 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 `true` if the operation was found in the store and `false` if not.
    fn has_operation_tx(&self, id: &ID) -> impl Future<Output = Result<bool, Self::Error>>;

    /// Delete an operation.
    ///
    /// Returns `true` when the removal occurred and `false` when the operation was not found in
    /// the store.
    fn delete_operation(&self, id: &ID) -> impl Future<Output = Result<bool, Self::Error>>;

    /// Delete an operation payload.
    ///
    /// Returns `true` when the removal occurred and `false` when the operation was not found in
    /// the store.
    fn delete_operation_payload(&self, id: &ID) -> impl Future<Output = Result<bool, Self::Error>>;
}