SineCache

SineCache is a high-performance, in-memory caching library for Rust, designed to efficiently store and manage key-value pairs with support for various eviction policies.

Features

Multiple Eviction Policies: Supports FIFO (First In, First Out), LRU (Least Recently Used), and LFU (Least Frequently Used) eviction policies out of the box.
Customizable: Define your own eviction policies by implementing a simple trait, enabling tailored cache behavior to suit specific application needs.
Efficient Memory Management: Optimizes memory usage by using references (KeyRef) to keys stored in the cache, reducing redundancy and improving performance.

Getting Started

To use SineCache in your Rust project, add it to your Cargo.toml:

[dependencies]

sine_cache = "0.1.0"

Example

use sine_cache::cache::Cache;
use sine_cache::eviction_policies::lfu::LFU;

fn main() {
    let capacity = 10; // Maximum number of entries in the cache.
    let mut cache = Cache::new(capacity, LFU::new());

    // Inserting key-value pairs into the cache
    cache.put(1, "One");
    cache.put(1, "one"); // Overwrites previous value
    cache.put(2, "Two");

    // Retrieving a value from the cache
    let value = cache.get(&1);
    println!("{:?}", value); // Output: Some("one")
}

This example demonstrates basic usage of SineCache with LFU eviction policy. You can easily switch to other eviction policies like FIFO or LRU by replacing LFU::new() with the desired policy constructor.

Warnings

Thread Safety: Warning: SineCache does not employ locking mechanisms. Concurrent access from multiple threads may lead to undefined behavior or data corruption. For multi-threaded applications, consider implementing appropriate locking strategies or using thread-safe alternatives.

License