Struct quick_kv::QuickClient

pub struct QuickClient { /* private fields */ }

The client for the QuickKV database

Examples

use quick_kv::QuickClient;

fn main() {
    let mut client = QuickClient::new(None).unwrap();

    client.set::<String>("hello", String::from("Hello World!")).unwrap();

    let result = client.get::<String>("hello").unwrap();

    assert_eq!(result, Some(String::from("Hello World!")));
}

Implementations

impl QuickClient

pub fn new(path: Option<PathBuf>) -> Result<Self>

Creates a new QuickClient instance

path The path to the database file

Examples

use quick_kv::QuickClient;

fn main() {
    let mut client = QuickClient::new(None).unwrap();
}

pub fn set<T>(&mut self, key: &str, value: T) -> Result<()>

where T: Serialize + DeserializeOwned + Clone + Debug,

Sets a key-value pair in the database

key The key of the key-value pair

value The value of the key-value pair

Examples

use quick_kv::QuickClient;

fn main() {
   let mut client = QuickClient::new(None).unwrap();

  client.set::<String>("hello", String::from("Hello World!")).unwrap();
}

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

where T: Serialize + DeserializeOwned + Clone + Debug,

Gets a value from the database

key The key of the key-value pair

Examples

use quick_kv::QuickClient;

fn main() {
  let mut client = QuickClient::new(None).unwrap();

  client.set::<String>("hello", String::from("Hello World!")).unwrap();
  let result = client.get::<String>("hello").unwrap();

  assert_eq!(result, Some(String::from("Hello World!")));
}

pub fn delete<T>(&mut self, key: &str) -> Result<()>

where T: Serialize + DeserializeOwned + Clone + Debug,

Deletes a key-value pair from the database

key The key of the key-value pair

Examples

use quick_kv::QuickClient;

fn main() {
   let mut client = QuickClient::new(None).unwrap();

   client.set::<String>("hello", String::from("Hello World!")).unwrap();

   client.delete::<String>("hello").unwrap();

   let result = client.get::<String>("hello").unwrap();

   assert_eq!(result, None);
}

pub fn update<T>(&mut self, key: &str, value: T) -> Result<()>

where T: Serialize + DeserializeOwned + Clone + Debug,

Updates a key-value pair in the database

key The key of the key-value pair

value The new value of the key-value pair

If no key is found, an error is returned and the database is not updated.

Examples

use quick_kv::QuickClient;

fn main() {
   let mut client = QuickClient::new(None).unwrap();

  client.set::<String>("hello", String::from("Hello")).unwrap();

  client.update::<String>("hello", String::from("Hello World!")).unwrap();    ///

  let result = client.get::<String>("hello").unwrap();

  assert_eq!(result, Some(String::from("Hello World!")));
}

Trait Implementations

impl Debug for QuickClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.