shardline-cache 1.0.0

Reconstruction-cache contracts and adapters for Shardline.
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

use std::{future::Future, pin::Pin};

use crate::{ReconstructionCacheError, ReconstructionCacheKey};

/// Boxed asynchronous reconstruction-cache operation.
pub type ReconstructionCacheFuture<'operation, T> =
    Pin<Box<dyn Future<Output = Result<T, ReconstructionCacheError>> + Send + 'operation>>;

/// Asynchronous reconstruction-cache adapter contract.
pub trait AsyncReconstructionCache: Send + Sync {
    /// Verifies that the adapter is configured correctly and can serve requests.
    fn ready(&self) -> ReconstructionCacheFuture<'_, ()>;

    /// Loads one cached reconstruction payload.
    fn get<'operation>(
        &'operation self,
        key: &'operation ReconstructionCacheKey,
    ) -> ReconstructionCacheFuture<'operation, Option<Vec<u8>>>;

    /// Stores one reconstruction payload.
    fn put<'operation>(
        &'operation self,
        key: &'operation ReconstructionCacheKey,
        payload: &'operation [u8],
    ) -> ReconstructionCacheFuture<'operation, ()>;

    /// Deletes one cached reconstruction payload.
    fn delete<'operation>(
        &'operation self,
        key: &'operation ReconstructionCacheKey,
    ) -> ReconstructionCacheFuture<'operation, bool>;
}