omnia-wasi-keyvalue 0.31.0

WASI key-value store interface for the Omnia runtime
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

use std::fmt::Debug;
use std::ops::Deref;
use std::sync::Arc;

pub use omnia::FutureResult;

/// Providers implement the [`Bucket`] trait to allow the host to
/// interact with different backend buckets (stores).
pub trait Bucket: Debug + Send + Sync + 'static {
    /// The name of the bucket.
    fn name(&self) -> &'static str;

    /// Get the value associated with the key.
    fn get(&self, key: String) -> FutureResult<Option<Vec<u8>>>;

    /// Set the value associated with the key.
    fn set(&self, key: String, value: Vec<u8>) -> FutureResult<()>;

    /// Delete the value associated with the key.
    fn delete(&self, key: String) -> FutureResult<()>;

    /// Check if the entry exists.
    fn exists(&self, key: String) -> FutureResult<bool>;

    /// List all keys in the bucket.
    fn keys(&self) -> FutureResult<Vec<String>>;
}

/// Proxy for a Key-Value bucket.
#[derive(Clone, Debug)]
pub struct BucketProxy(pub Arc<dyn Bucket>);

impl Deref for BucketProxy {
    type Target = Arc<dyn Bucket>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

/// CAS (Compare-And-Swap) operation handle.
#[derive(Clone, Debug)]
pub struct Cas {
    /// The key associated with the CAS operation.
    pub key: String,

    /// The current value associated with the key.
    pub current: Option<Vec<u8>>,
}