Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 2.11 KB

README.md

File metadata and controls

51 lines (34 loc) · 2.11 KB

foyer

Crates.io Version Crates.io MSRV GitHub License

CI (main) License Checker codecov

foyer aims to be a user-friendly hybrid cache lib in Rust.

foyer is inspired by Facebook/CacheLib, which is an excellent hybrid cache lib in C++. foyer is not only a 'rewrite in Rust project', but provide some features that CacheLib doesn't have for now.

Supported Rust Versions

foyer is built against the latest stable release. The minimum supported version is 1.77.2. The current foyer version is not guaranteed to build on Rust versions earlier than the minimum supported version.

Development state

Currently, foyer only finished few features, and is still under heavy development.

Features

  • in-memory cache
    • FIFO
    • LRU with priority pool
    • 3-qeue w-TinyLFU (imspired by caffeine)
    • S3FIFO without Ghost Queue
  • disk cache
  • TTL (time to live)

Examples

The examples can be found here.

Roadmap

  • More user-friendly API.
  • User-friendly Documents and examples.
  • Support TTL.
  • Simplify foyer-storage.
  • Refactor foyer-storage region reclaiming policy.
  • Support on Windows.
  • Unify in-memory cache and disk cache configuration.

Contributing

Contributions for foyer are welcomed! Issues can be found here.

Make sure you've passed make check and make test before request a review, or CI will fail.