Crate foyer

A hybrid cache library that supports plug-and-play cache algorithms, in-memory cache and disk cache.

Website | Tutorial | API Docs | Crate

Structs

• AdmitAllPicker
  A picker that always returns true.
• CacheBuilder
  In-memory cache builder.
• DeviceStats
  The statistics information of the device.
• DirectFileDevice
  A device that uses a single direct i/o file.
• DirectFileDeviceOptions
  Options for the direct file device.
• DirectFileDeviceOptionsBuilder
  DirectFileDeviceOptionsBuilder is used to build the options for the direct fs device.
• DirectFsDevice
  A device that uses direct i/o files in a directory of a file system.
• DirectFsDeviceOptions
  Options for the direct fs device.
• DirectFsDeviceOptionsBuilder
  DirectFsDeviceOptionsBuilder is used to build the options for the direct fs device.
• FifoConfig
  Fifo eviction algorithm config.
• FifoPicker
  A picker that pick region to eviction with a FIFO behavior.
• HybridCache
  Hybrid cache that integrates in-memory cache and disk cache.
• HybridCacheBuilder
  Hybrid cache builder.
• HybridCacheBuilderPhaseMemory
  Hybrid cache builder to modify the in-memory cache configurations.
• HybridCacheBuilderPhaseStorage
  Hybrid cache builder modify the disk cache configurations.
• HybridCacheStorageWriter
  Writer for disk cache of a hybrid cache to support more flexible write APIs.
• HybridCacheWriter
  Writer for hybrid cache to support more flexible write APIs.
• HybridFetchInner
  A future that is used to get entry value from the remote storage for the hybrid cache.
• InvalidRatioPicker
  Evict the region with the largest invalid data ratio.
• LfuConfig
  w-TinyLFU eviction algorithm config.
• LruConfig
  LRU eviction algorithm config.
• RateLimitPicker
  A picker that picks based on the disk statistics and the given rate limit.
• RejectAllPicker
  A picker that always returns false.
• Runtime
  Runtime holds the runtime reference and non-clonable handles to prevent handle usage after runtime shutdown.
• S3FifoConfig
  S3FIFO eviction algorithm config.
• Store
  The disk cache engine that serves as the storage backend of foyer.
• StoreBuilder
  The builder of the disk cache.
• TokioRuntimeConfig
  Tokio runtime configuration.
• TombstoneLogConfigBuilder
  The builder for the tombstone log config.
• TracingConfig
  Configurations for tracing.

Enums

• Cache
  In-memory cache with plug-and-play algorithms.
• CacheContext
  Context of the cache entry.
• CacheEntry
  A cached entry holder of the in-memory cache.
• Compression
  The compression algorithm of the disk cache.
• EvictionConfig
  Eviction algorithm config.
• FetchState
  The state of [Fetch].
• RecoverMode
  The recover mode of the disk cache.
• RuntimeConfig
  Configuration for the dedicated runtime.

Traits

• AdmissionPicker
  The admission picker for the disk cache.
• BufExt
  Extend Buf with get_isize() and get_usize().
• BufMutExt
  Extend BufMut with put_isize() and put_usize().
• Dev
  Dev represents 4K aligned block device.
• DevExt
  Device extend interfaces.
• DevOptions
  Options for the device.
• EventListener
  Trait for the customized event listener.
• EvictionPicker
  The eviction picker for the disk cache.
• Key
  Key trait for the in-memory cache.
• RangeBoundsExt
  The range extensions.
• ReinsertionPicker
  The reinsertion picker for the disk cache.
• Storage
  The storage trait for the disk cache storage engine.
• StorageKey
  Key trait for the disk cache.
• StorageValue
  Value trait for the disk cache.
• Value
  Value trait for the in-memory cache.
• Weighter
  The weighter for the in-memory cache.

Type Aliases

• HybridCacheEntry
  A cached entry holder of the hybrid cache.
• HybridFetch
  The future generated by HybridCache::fetch.