Struct shmap::Shmap

pub struct Shmap { /* private fields */ }

Implementations

impl Shmap

pub fn new() -> Self

Initialize Shmap with no TTL or encryption.

pub fn new_with_encryption(encryption_key: &[u8; 32]) -> Self

Initialize Shmap with AES256 encryption key (random bytes).

pub fn get<T>(&self, key: &str) -> Result<Option<T>, ShmapError> where
    T: DeserializeOwned, 

Get an item value by its key, and deserialize it (using bincode) to T.

pub fn get_raw(&self, key: &str) -> Result<Option<Vec<u8>>, ShmapError>

Get an item by its key, without deserialization, as bytes.

pub fn insert<T>(&self, key: &str, value: T) -> Result<(), ShmapError> where
    T: Serialize, 

Insert a new item, using bincode serialization.

pub fn insert_with_ttl<T>(
    &self,
    key: &str,
    value: T,
    ttl: Duration
) -> Result<(), ShmapError> where
    T: Serialize, 

Insert a new item, using bincode serialization, with a TTL.

pub fn insert_raw_with_ttl(
    &self,
    key: &str,
    value: &[u8],
    ttl: Duration
) -> Result<(), ShmapError>

Insert a new item, without serialization, with a TTL.

pub fn insert_raw(&self, key: &str, value: &[u8]) -> Result<(), ShmapError>

Insert a new item, without serialization.

pub fn remove(&self, key: &str) -> Result<(), ShmapError>

Remove an item by its key.

pub fn keys(&self) -> Result<Vec<String>, ShmapError>

List available keys.

pub fn clean(&self) -> Result<Vec<String>, ShmapError>

Clean expired items.

Trait Implementations

impl Clone for Shmap

fn clone(&self) -> Shmap

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Shmap

fn default() -> Self

Default is Shmap without encryption.