p2panda-rs 0.7.0

All the things a panda needs
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

// SPDX-License-Identifier: AGPL-3.0-or-later

use async_trait::async_trait;

use crate::document::DocumentId;
use crate::entry::LogId;
use crate::identity::PublicKey;
use crate::schema::SchemaId;
use crate::storage_provider::error::LogStorageError;

/// Storage interface for inserting and querying `Entries`.
///
/// Logs are derived from the `Entries` which arrive at and are stored on a node. These methods
/// should be used to store new logs when so needed and then to perform queries on the stored data.
///
/// Each log, as well as all `Entries` and `Operations` it contains, is associated with exactly one
/// `PublicKey`, `SchemaId` and `DocumentId`.
#[async_trait]
pub trait LogStore {
    /// Insert a log into the store.
    ///
    /// Returns an error if a fatal storage error occurred.
    async fn insert_log(
        &self,
        log_id: &LogId,
        public_key: &PublicKey,
        schema: &SchemaId,
        document: &DocumentId,
    ) -> Result<bool, LogStorageError>;

    /// Get the `LogId` for a `PublicKey` and `DocumentId`.
    ///
    /// Returns a `LogId` or `None` if no log exists with the passed `PublicKey` and `DocumentId`.
    async fn get_log_id(
        &self,
        public_key: &PublicKey,
        document_id: &DocumentId,
    ) -> Result<Option<LogId>, LogStorageError>;

    /// Get the latest used `LogId` for a `PublicKey`.
    ///
    /// Returns a `LogId` or `None` if the passed `PublicKey` has not published any entry yet.
    async fn latest_log_id(&self, public_key: &PublicKey)
        -> Result<Option<LogId>, LogStorageError>;
}