Struct forceps::CacheBuilder

pub struct CacheBuilder { /* fields omitted */ }

A builder for the Cache object. Exposes APIs for configuring the initial setup of the database.

Examples

use forceps::CacheBuilder;

let cache = CacheBuilder::new("./cache")
    .dir_depth(3)
    .read_write_buffer(1024 * 16)
    .build()
    .await
    .unwrap();

Implementations

impl CacheBuilder

pub fn new<P: AsRef<Path>>(path: P) -> Self

Creates a new CacheBuilder, which can be used to customize and create a Cache instance.

The path supplied is the base directory of the cache instance.

Examples

use forceps::CacheBuilder;

let builder = CacheBuilder::new("./cache");
// Use other methods for configuration

pub fn dir_depth(self, depth: u8) -> Self

Sets the depth of directories created in the cache folder.

Default is 2

This will set the depth of folders created and expected when reading and writing to the database. Increasing this value could increase the time to write to the database.

Breaking Warning

Changing this value on a live database without migrations will cause the database read operations to essentially skip over the data. This means that all data will be inaccessible, despite the metadata being accessible.

pub fn read_write_buffer(self, size: usize) -> Self

Changes the in-memory buffer sizes for reading and writing fs operations.

Default is 8kb (8196)

Increasing this value may benefit performance as more bulk reading is involved. However, this option completely depends on the size of the data you are reading/writing.

pub async fn build(self) -> Result<Cache>

Builds the new Cache instance using the configured options of the builder.

Examples

use forceps::Cache;

let cache = Cache::new("./cache")
    .build()
    .await
    .unwrap();

Trait Implementations

impl Clone for CacheBuilder

fn clone(&self) -> CacheBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CacheBuilder

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

Formats the value using the given formatter.

impl Default for CacheBuilder

fn default() -> Self

Creates a CacheBuilder with the directory set to ./cache.

Examples

use forceps::CacheBuilder;

let cache = CacheBuilder::default()
    .build()
    .await
    .unwrap();