Struct StoreBuilder 

pub struct StoreBuilder<K, V, S, P>
where
    K: StorageKey,
    V: StorageValue,
    S: HashBuilder + Debug,
    P: Properties,
{ /* private fields */ }

The builder of the disk cache.

Implementations

impl<K, V, S, P> StoreBuilder<K, V, S, P>

where K: StorageKey, V: StorageValue, S: HashBuilder + Debug, P: Properties,

pub fn new( name: impl Into<Cow<'static, str>>, memory: Cache<K, V, S, P>, metrics: Arc<Metrics>, ) -> Self

Setup disk cache store for the given in-memory cache.

pub fn with_io_engine_config( self, io_engine_builder: impl Into<Box<dyn IoEngineConfig>>, ) -> Self

Set io engine config for the disk cache store.

Default: crate::io::engine::psync::PsyncIoEngineConfig.

pub fn with_engine_config( self, config: impl Into<Box<dyn EngineConfig<K, V, P>>>, ) -> Self

Set engine config for the disk cache store.

pub fn with_compression(self, compression: Compression) -> Self

Set the compression algorithm of the disk cache store.

Default: Compression::None.

pub fn with_recover_mode(self, recover_mode: RecoverMode) -> Self

Set the recover mode for the disk cache store.

See more in RecoverMode.

Default: RecoverMode::Quiet.

pub fn with_spawner(self, spawner: Spawner) -> Self

Configure the task spawner for the disk cache store.

By default, it will use the current spawner that built foyer.

For example, with tokio, it will be tokio::runtime::Handle::current().

FYI: Spawner and Spawner::current()

pub async fn build(self) -> Result<Store<K, V, S, P>>

Build the disk cache store with the given configuration.

Trait Implementations

impl<K, V, S, P> Debug for StoreBuilder<K, V, S, P>

where K: StorageKey, V: StorageValue, S: HashBuilder + Debug, P: Properties,

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

Formats the value using the given formatter.