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 builder = CacheBuilder::new("./cache");

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 async fn build(self) -> Result<Cache>

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

Examples

use forceps::CacheBuilder;

let cache = CacheBuilder::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();