Struct caves::FileCave

pub struct FileCave { /* fields omitted */ }

A key-value store that stores keys in files.

This kv stores keys as files in a directory. Note that the directory must exist.

Caveats

This kv has the following caveats:

• It doesn't perform a sync operation after every set/delete.
• It doesn't create multi-level directories, e.g., fi/le/name, to improve filesystem lookups.

Consider using it when you want to audit which keys are created using external tools, such as ls, cat.

Methods

impl FileCave

pub fn new(dir: &Path) -> Result<Self, Error>

Create a new instance.

Check if the provided path is a directory and that it exists.

Trait Implementations

impl Cave for FileCave

fn get(&self, name: &str) -> Res

Get a key by its name, and return its contents.

fn set(&self, name: &str, data: &[u8]) -> Res

Create or update a key by its name.

fn delete(&self, name: &str) -> Res

Delete a key by its name.

fn not_found(&self, name: &str) -> Res

A helper method to return an error for keys that could not be found.

impl Debug for FileCave

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

Formats the value using the given formatter.