[go: up one dir, main page]

http-cache 0.1.0

An HTTP caching middleware
Documentation

http-cache

Rust crates.io Docs.rs

A caching middleware that follows HTTP caching rules, thanks to http-cache-semantics. By default it uses cacache as the backend cache manager.

Supported Clients

  • Surf *Should likely be registered after any middleware modifying the request
  • Reqwest *Uses reqwest-middleware for middleware support

Install

With cargo add installed :

cargo add http-cache

Examples

Surf (feature: client-surf)

use http_cache::{Cache, CacheMode, CACacheManager};

#[async_std::main]
async fn main() -> surf::Result<()> {
    let req = surf::get("https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching");
    surf::client()
        .with(Cache {
            mode: CacheMode::Default,
            cache_manager: CACacheManager::default(),
        })
        .send(req)
        .await?;
    Ok(())
}

Reqwest (feature: client-reqwest)

use reqwest::Client;
use reqwest_middleware::{ClientBuilder, Result};
use http_cache::{Cache, CacheMode, CACacheManager};

#[tokio::main]
async fn main() -> Result<()> {
    let client = ClientBuilder::new(Client::new())
        .with(Cache {
            mode: CacheMode::Default,
            cache_manager: CACacheManager::default(),
        })
        .build();
    client
        .get("https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching")
        .send()
        .await?;
    Ok(())
}

Features

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

  • manager-cacache (default): use cacache, a high-performance disk cache, for the manager backend.
  • client-surf (disabled): enables surf client support.
  • client-reqwest (disabled): enables reqwest client support.
  • fancy-errors (disabled): enables miette fancy errors.

Documentation

License

Licensed under either of

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.