Struct KV 

pub struct KV<K, V> { /* private fields */ }

The type that represents the key-value store

Implementations

impl<K: Clone + Serialize + Deserialize + Eq + Hash, V: Clone + Serialize + Deserialize> KV<K, V>

pub fn new(p: &'static str) -> Result<KV<K, V>, KVError>

Creates a new instance of the KV store

Examples found in repository

examples/custom_types.rs (line 22)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<MyKey, MyValue>::new(cab_path).unwrap();

    let _ = test_store.insert(MyKey::Int(1i32), MyValue::String("value".to_string()));
    println!("{:?}", test_store.get(MyKey::Int(1i32)));
    let _ = test_store.remove(MyKey::Int(1i32));


    // clean up the cab
    let _ = std::fs::remove_file(cab_path);
}

examples/main.rs (line 7)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<String, Value>::new(cab_path).unwrap();

    let _ = test_store.insert("key".to_string(), Value::String("value".to_string()));
    println!("{:?}", test_store.get("key".to_string()).unwrap());
    let _ = test_store.remove("key".to_string());

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap() 
        .insert("key".to_string(), Value::String("value".to_string()));

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap()
        .remove("key".to_string());

    let _ = std::fs::remove_file(cab_path);
}

pub fn insert(&mut self, key: K, value: V) -> Result<bool, KVError>

Inserta a key, value pair into the key-value store

Examples found in repository

examples/custom_types.rs (line 24)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<MyKey, MyValue>::new(cab_path).unwrap();

    let _ = test_store.insert(MyKey::Int(1i32), MyValue::String("value".to_string()));
    println!("{:?}", test_store.get(MyKey::Int(1i32)));
    let _ = test_store.remove(MyKey::Int(1i32));


    // clean up the cab
    let _ = std::fs::remove_file(cab_path);
}

examples/main.rs (line 9)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<String, Value>::new(cab_path).unwrap();

    let _ = test_store.insert("key".to_string(), Value::String("value".to_string()));
    println!("{:?}", test_store.get("key".to_string()).unwrap());
    let _ = test_store.remove("key".to_string());

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap() 
        .insert("key".to_string(), Value::String("value".to_string()));

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap()
        .remove("key".to_string());

    let _ = std::fs::remove_file(cab_path);
}

pub fn get(&mut self, key: K) -> Result<Option<V>, KVError>

Get the value from a key

Examples found in repository

examples/custom_types.rs (line 25)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<MyKey, MyValue>::new(cab_path).unwrap();

    let _ = test_store.insert(MyKey::Int(1i32), MyValue::String("value".to_string()));
    println!("{:?}", test_store.get(MyKey::Int(1i32)));
    let _ = test_store.remove(MyKey::Int(1i32));


    // clean up the cab
    let _ = std::fs::remove_file(cab_path);
}

examples/main.rs (line 10)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<String, Value>::new(cab_path).unwrap();

    let _ = test_store.insert("key".to_string(), Value::String("value".to_string()));
    println!("{:?}", test_store.get("key".to_string()).unwrap());
    let _ = test_store.remove("key".to_string());

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap() 
        .insert("key".to_string(), Value::String("value".to_string()));

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap()
        .remove("key".to_string());

    let _ = std::fs::remove_file(cab_path);
}

pub fn remove(&mut self, key: K) -> Result<bool, KVError>

Removes a key and associated value from the key-value Store

Examples found in repository

examples/custom_types.rs (line 26)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<MyKey, MyValue>::new(cab_path).unwrap();

    let _ = test_store.insert(MyKey::Int(1i32), MyValue::String("value".to_string()));
    println!("{:?}", test_store.get(MyKey::Int(1i32)));
    let _ = test_store.remove(MyKey::Int(1i32));


    // clean up the cab
    let _ = std::fs::remove_file(cab_path);
}

examples/main.rs (line 11)

fn main() {
    let cab_path = "./db.cab";
    let mut test_store = KV::<String, Value>::new(cab_path).unwrap();

    let _ = test_store.insert("key".to_string(), Value::String("value".to_string()));
    println!("{:?}", test_store.get("key".to_string()).unwrap());
    let _ = test_store.remove("key".to_string());

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap() 
        .insert("key".to_string(), Value::String("value".to_string()));

    let _ = KV::<String, Value>::new(cab_path)
        .unwrap()
        .remove("key".to_string());

    let _ = std::fs::remove_file(cab_path);
}

pub fn keys(&mut self) -> Result<Vec<K>, KVError>

get all the keys contained in the KV Store