Struct Collection

pub struct Collection<'a, T> { /* private fields */ }

Represents a collection of documents.

It is the main API for data managment for Keratin.

Implementations

impl<'a, T: Serialize + Clone + for<'de> Deserialize<'de>> Collection<'a, T>

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

Returns an entry of the database given the respective key, or None if the key corresponds to no known entries

pub fn truncate(&mut self) -> Result<()>

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

Insert an entry into the database given an Entry

Note

This does not cache the entry automaticaly

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

Delete a entry in the database given the key.

This deletes from both the cache and non-volatile storage.

Note

In the future this will use a query string to find what multiple elements to delete

Return

Returns an Error EntryNotFound if the key does not match any entry

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

pub fn configure( path: Option<&str>, se: &'a dyn StorageEngine<T>, ) -> Result<Collection<'a, T>>

A function to initialize the collection using the path of a configuration file

Arguments

• path - An Option with a Path. If this is None, Keratin will use the default config file path (eg. db/keratin.toml)

• se - The Storage Engine of the database. Right now only LocalFsStorage is implemented into the crate, but in theory anything that implements the StorageEngine trait could be passed as the parameter.

Errors

This returns an error if the config file is not found OR if the folder doesn’t have the right permitions

pub fn iter_mut(&mut self) -> Result<IterMut<'_, String, T>>

Trait Implementations

impl<'a, T: Clone> Clone for Collection<'a, T>

fn clone(&self) -> Collection<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.