Shmap

Struct Shmap 

Source
pub struct Shmap { /* private fields */ }

Implementations§

Source§

impl Shmap

Source

pub fn new() -> Self

Initialize Shmap with no TTL or encryption.

Source

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

Initialize Shmap with AES256 encryption key (random bytes).

Source

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

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

Source

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

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

Source

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

Insert a new item, using bincode serialization.

Source

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.

Source

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

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

Source

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

Insert a new item, without serialization.

Source

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

Remove an item by its key.

Source

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

List available keys.

Source

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

Clean expired items.

Trait Implementations§

Source§

impl Clone for Shmap

Source§

fn clone(&self) -> Shmap

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Shmap

Source§

fn default() -> Self

Default is Shmap without encryption.

Auto Trait Implementations§

§

impl Freeze for Shmap

§

impl RefUnwindSafe for Shmap

§

impl Send for Shmap

§

impl Sync for Shmap

§

impl Unpin for Shmap

§

impl UnwindSafe for Shmap

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V