Struct LiquidCacheBuilder 

pub struct LiquidCacheBuilder { /* private fields */ }

Builder for LiquidCache.

Example:

use liquid_cache::cache::LiquidCacheBuilder;
use liquid_cache::cache_policies::LiquidPolicy;

tokio_test::block_on(async {
    let _storage = LiquidCacheBuilder::new()
        .with_batch_size(8192)
        .with_max_memory_bytes(1024 * 1024 * 1024)
        .with_cache_policy(Box::new(LiquidPolicy::new()))
        .build()
        .await;
});

Implementations

impl LiquidCacheBuilder

pub fn new() -> Self

Create a new instance of LiquidCacheBuilder.

pub fn with_batch_size(self, batch_size: usize) -> Self

Set the batch size for the cache. Default is 8192.

pub fn with_max_memory_bytes(self, max_memory_bytes: usize) -> Self

Set the max memory bytes for the cache. Default is 1GB.

pub fn with_max_disk_bytes(self, max_disk_bytes: usize) -> Self

Set the max disk bytes for the cache. Default is unlimited.

pub fn with_cache_policy(self, policy: Box<dyn CachePolicy>) -> Self

Set the cache policy for the cache. Default is LiquidPolicy.

pub fn with_hydration_policy(self, policy: Box<dyn HydrationPolicy>) -> Self

Set the hydration policy for the cache. Default is crate::cache::NoHydration.

pub fn with_squeeze_policy(self, policy: Box<dyn SqueezePolicy>) -> Self

Set the squeeze policy for the cache. Default is TranscodeSqueezeEvict.

pub fn with_metadata(self, metadata: Arc<dyn EntryMetadata>) -> Self

Set the EntryMetadata for the cache. Default is DefaultCacheMetadata.

pub fn with_store(self, store: Store) -> Self

Set the t4::Store used for on-disk IO. If not provided, the builder mounts a fresh store at a temporary directory.

pub fn with_squeeze_victims_concurrently(self, enabled: bool) -> Self

Set whether cache victims are squeezed concurrently.

pub async fn build(self) -> Arc<LiquidCache>

Build the cache storage.

The cache storage is wrapped in an Arc to allow for concurrent access. When no t4::Store is provided, one is mounted at a temporary directory.

Trait Implementations

impl Default for LiquidCacheBuilder

fn default() -> Self

Returns the “default value” for a type.