rskit-stateful 0.2.0-alpha.1

Stateful accumulators with triggers, measurers, and TTL cleanup
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

//! Store abstraction for accumulator backends.

use tokio::time::Instant;

use rskit_errors::AppResult;

/// Backend storage for an [`crate::Accumulator`].
pub trait Store<V>: Send + Sync
where
    V: Clone,
{
    /// Append a new value.
    fn append(&self, value: V) -> AppResult<()>;

    /// Remove and return the oldest value, if any.
    fn pop_oldest(&self) -> AppResult<Option<V>>;

    /// Snapshot all currently buffered values.
    fn snapshot(&self) -> AppResult<Vec<V>>;

    /// Drain and return all currently buffered values.
    fn flush(&self) -> AppResult<Vec<V>>;

    /// Return the current item count.
    fn size(&self) -> AppResult<usize>;

    /// Update last-activity metadata.
    fn touch(&self) -> AppResult<()>;

    /// Return the last activity timestamp.
    fn last_activity(&self) -> AppResult<Instant>;

    /// Release store resources.
    fn close(&self) -> AppResult<()>;
}