Struct S2BaseStore 

pub struct S2BaseStore<R: StdReader = FileReader, K: U64 = u64, V: Serialize + DeserializeOwned = Properties> { /* private fields */ }

Available on crate feature std only.

NOTE: The File KVStore is designed to be used in states:

• write-only. The initial state is write-only. Write all you need to before reading
• read-only. Once you have written everything, the first read will lock the file to be static and read-only.

Implementations

impl<R: StdReader, K: U64, V: Serialize + DeserializeOwned> S2BaseStore<R, K, V>

pub fn new(file_name: Option<&str>, options: Option<FileOptions>) -> Self

Builds a new File based KV

pub fn len(&self) -> u64

Returns the number of entries

pub fn is_empty(&self) -> bool

Returns true if the store is empty

pub fn set(&mut self, key: K, value: V)

Sets the value for the given key

pub fn has(&mut self, key: K) -> bool

Checks if the store contains a key

pub fn get(&mut self, key: K, max: Option<usize>) -> Option<(u64, Vec<V>)>

Get the values in relation to the given key Returns None if the key does not exist, but will return the index of the first match with all values of key if the key exists

pub fn get_index(&mut self, index: u64) -> Option<(K, V)>

Get the value at the given index. Return (key, value)

pub fn sort(&mut self)

Sort the data if not sorted

pub fn cleanup(&mut self)

Closes the store

pub fn iter(&mut self) -> Iter<'_, R, K, V>

Iterate over the store, one key-value at a time

pub fn iter_multi(&mut self) -> IterMulti<'_, R, K, V>

Iterate over the store but group all values related to a key

Trait Implementations

impl<R: Clone + StdReader, K: Clone + U64, V: Clone + Serialize + DeserializeOwned> Clone for S2BaseStore<R, K, V>

fn clone(&self) -> S2BaseStore<R, K, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug + StdReader, K: Debug + U64, V: Debug + Serialize + DeserializeOwned> Debug for S2BaseStore<R, K, V>

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

Formats the value using the given formatter.

impl<R: StdReader, K: U64, V: Serialize + DeserializeOwned> Default for S2BaseStore<R, K, V>

fn default() -> Self

Returns the “default value” for a type.