Struct foyer::HybridCacheBuilderPhaseStorage

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

Hybrid cache builder modify the disk cache configurations.

Implementations

impl<K, V, S> HybridCacheBuilderPhaseStorage<K, V, S>

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

pub fn with_device_config(self, device_config: impl Into<DeviceConfig>) -> Self

Set device config for the disk cache store.

pub fn with_flush(self, flush: bool) -> Self

Enable/disable sync after writes.

Default: false.

pub fn with_indexer_shards(self, indexer_shards: usize) -> Self

Set the shard num of the indexer. Each shard has its own lock.

Default: 64.

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_recover_concurrency(self, recover_concurrency: usize) -> Self

Set the recover concurrency for the disk cache store.

Default: 8.

pub fn with_flushers(self, flushers: usize) -> Self

Set the flusher count for the disk cache store.

The flusher count limits how many regions can be concurrently written.

Default: 1.

pub fn with_reclaimers(self, reclaimers: usize) -> Self

Set the reclaimer count for the disk cache store.

The reclaimer count limits how many regions can be concurrently reclaimed.

Default: 1.

pub fn with_buffer_threshold(self, threshold: usize) -> Self

👎Deprecated since 0.11.4: The function will be renamed to “with_buffer_pool_size()”, use it instead.

Set the total flush buffer threshold.

Each flusher shares a volume at threshold / flushers.

If the buffer of the flush queue exceeds the threshold, the further entries will be ignored.

Default: 16 MiB.

pub fn with_buffer_pool_size(self, buffer_pool_size: usize) -> Self

Set the total flush buffer pool size.

Each flusher shares a volume at threshold / flushers.

If the buffer of the flush queue exceeds the threshold, the further entries will be ignored.

Default: 16 MiB.

pub fn with_clean_region_threshold(self, clean_region_threshold: usize) -> Self

Set the clean region threshold for the disk cache store.

The reclaimers only work when the clean region count is equal to or lower than the clean region threshold.

Default: the same value as the reclaimers.

pub fn with_eviction_pickers( self, eviction_pickers: Vec<Box<dyn EvictionPicker>>, ) -> Self

Set the eviction pickers for th disk cache store.

The eviction picker is used to pick the region to reclaim.

The eviction pickers are applied in order. If the previous eviction picker doesn’t pick any region, the next one will be applied.

If no eviction picker picks a region, a region will be picked randomly.

Default: [ invalid ratio picker { threshold = 0.8 }, fifo picker ]

pub fn with_admission_picker( self, admission_picker: Arc<dyn AdmissionPicker<Key = K>>, ) -> Self

Set the admission pickers for th disk cache store.

The admission picker is used to pick the entries that can be inserted into the disk cache store.

Default: [AdmitAllPicker].

pub fn with_reinsertion_picker( self, reinsertion_picker: Arc<dyn ReinsertionPicker<Key = K>>, ) -> Self

Set the reinsertion pickers for th disk cache store.

The reinsertion picker is used to pick the entries that can be reinsertion into the disk cache store while reclaiming.

Note: Only extremely important entries should be picked. If too many entries are picked, both insertion and reinsertion will be stuck.

Default: [RejectAllPicker].

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

Set the compression algorithm of the disk cache store.

Default: Compression::None.

pub fn with_tombstone_log_config( self, tombstone_log_config: TombstoneLogConfig, ) -> Self

Enable the tombstone log with the given config.

For updatable cache, either the tombstone log or RecoverMode::None must be enabled to prevent from the phantom entries after reopen.

pub fn with_runtime_config(self, runtime_config: RuntimeConfig) -> Self

Configure the dedicated runtime for the disk cache store.

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

Build and open the hybrid cache with the given configurations.