Struct snapper_box::file::LsmFile

pub struct LsmFile<T, K> where
    T: Read + Write + Seek,
    K: Key,  { /* fields omitted */ }

LSM Abstraction over something File like (i.e. implementing Read, Write, and Seek).

This type maintains a write cache in memory, and you must call the flush method for the changes to be persisted. This type will not automatically flush.l

Implementations

impl<T, K> LsmFile<T, K> where
    T: Read + Write + Seek,
    K: Key, 

pub fn new(
    file: T,
    compression: Option<i32>,
    key: Arc<K>,
    max_cache_entries: Option<usize>
) -> Result<Self, Error>

Creates a new LsmFile from the provided, already existing, File like object.

Accepts values for the compression level for the file, the key to be used for encryption/decryption, as well as the maximum number of cache entries before a mandatory flush occurs, which defaults to 100.

Errors

• Error::EntryIO if an error occurs while reading the entries
• Will bubble up any segment errors`

pub fn get<C, V>(&mut self, key: &C) -> Result<Option<V>, Error> where
    C: Serialize,
    V: DeserializeOwned, 

Retries a value from the store given a key, if the value exists in the store.

The most recently inserted version of the value will be returned

Errors

Will return an error if any IO error occurs, or if the value fails to deserialize.

pub fn insert<C, V>(&mut self, key: &C, value: &V) -> Result<(), Error> where
    C: Serialize,
    V: Serialize, 

Inserts an object into the store

This method will write to the cache, however, if this insertion makes the cache size greater than or equal to the maximum number of entries, the current cache will be flushed.

Errors

• Will return an error if either the key or value fail to serialize
• Will bubble up any IO errors that occur, if a flush occurs

pub fn flush(&mut self) -> Result<(), Error>

Flushes the cache to disk

Errors

Will bubble up any IO errors

pub fn to_hashmap<C, V>(&mut self) -> Result<HashMap<C, V>, Error> where
    C: DeserializeOwned + Serialize + Hash + Eq,
    V: DeserializeOwned, 

Converts the current contents of the store to a HashMap.

Iterates through this LsmFIle’s keys, and insert them all into the returned HashMap. The most up to date value will be used for each key.

Errors

Will bubble up any error that occurs during a get operation

pub fn to_pairs<C, V>(&mut self) -> Result<Vec<(C, V)>, Error> where
    C: DeserializeOwned + Serialize + Eq + Clone,
    V: DeserializeOwned + Clone, 

Converts the current contents of the store to a Vec of pairs.

Iterates through this LsmFIle’s keys, and insert them all into the returned Vec]. The most up to date value will be used for each key.

Errors

Will bubble up any error that occurs during a get operation

pub fn into_inner(self) -> T

Consumes self and returns the inner File like object

impl<K> LsmFile<File, K> where
    K: Key, 

pub fn open(
    path: impl AsRef<Path> + Debug,
    compression: Option<i32>,
    key: Arc<K>,
    max_cache_entries: Option<usize>
) -> Result<Self, Error>

Opens an existing LsmFile from the provided path.

Will open the file in read/write mode. Will fail if the file does not exists.

Errors

• If the file does not exist
• If any other IO occurs
• If any of the decryption or deserialization of control structures fails

pub fn create(
    path: impl AsRef<Path> + Debug,
    compression: Option<i32>,
    key: Arc<K>,
    max_cache_entries: Option<usize>
) -> Result<Self, Error>

Opens an existing LsmFile from the provided path.

Will create the file in read/write mode, failing if the file exists

Errors

• If the file already exists
• If any other IO occurs