http-cache-surf

A caching middleware that follows HTTP caching rules, thanks to http-cache-semantics. By default, it uses redb as the backend cache manager. Should likely be registered after any middleware modifying the request.

Minimum Supported Rust Version (MSRV)

1.89.0

Install

With cargo add installed :

cargo add http-cache-surf

Example

use http_cache_surf::{Cache, CacheMode, RedbManager, HttpCache, HttpCacheOptions};

#[async_std::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let req = surf::get("https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching");
    surf::client()
        .with(Cache(HttpCache {
          mode: CacheMode::Default,
          manager: RedbManager::new("./http-cache.redb")?,
          options: HttpCacheOptions::default(),
        }))
        .send(req)
        .await?;
    Ok(())
}

Features

The following features are available. By default manager-redb is enabled.

• manager-redb (default): enable redb, an embedded, persistent disk cache, backend manager.
• manager-cacache: enable cacache, a high-performance disk cache, backend manager.
• manager-moka (disabled): enable moka, a high-performance in-memory cache, backend manager.
• manager-foyer (disabled): enable foyer, a hybrid in-memory + disk cache, backend manager.

Documentation

• API Docs

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.