Struct perkv::KV

pub struct KV<K, V>(_, _);

The type that represents the key-value store

Methods

impl<K, V> KV<K, V> where
    K: Eq + Serialize,
    V: for<'vde> Deserialize<'vde> + Serialize, 

pub fn new(p: &str) -> PRes<KV<K, V>>

Creates a new instance of the KV store

pub fn insert<Q: ?Sized, U: ?Sized>(&self, key: &Q, value: &U) -> PRes<()> where
    K: Borrow<Q>,
    Q: Eq + Serialize,
    V: Borrow<U>,
    U: Serialize, 

Inserts a key-value pair into the KV store

The key may be any borrowed form of the store's key type, but Eq and Serialize on the borrowed form must match those for the key type. This also applies to value type/store's value type.

pub fn get<Q: ?Sized>(&self, key: &Q) -> PRes<Option<V>> where
    K: Borrow<Q>,
    Q: Eq + Serialize, 

Gets the associated value from a key

The key may be any borrowed form of the store's key type, but Eq and Serialize on the borrowed form must match those for the key type.

pub fn remove<Q: ?Sized>(&self, key: &Q) -> PRes<()> where
    K: Borrow<Q>,
    Q: Eq + Serialize, 

Removes a key and associated value from the KV store

The key may be any borrowed form of the store's key type, but Eq and Serialize on the borrowed form must match those for the key type.

pub fn keys<B>(&self) -> PRes<B> where
    K: for<'kde> Deserialize<'kde>,
    B: FromIterator<K>, 

Gets all the keys contained in the KV Store

pub fn clear(&self) -> PRes<()>

Removes all entries from the KV store

Trait Implementations

impl<K, V> Clone for KV<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.