lintel-schema-cache 0.0.5

Disk-backed cache for JSON Schema files with pluggable HTTP and jsonschema integration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# lintel-schema-cache

[![Crates.io](https://img.shields.io/crates/v/lintel-schema-cache.svg)](https://crates.io/crates/lintel-schema-cache)
[![docs.rs](https://docs.rs/lintel-schema-cache/badge.svg)](https://docs.rs/lintel-schema-cache)
[![CI](https://github.com/lintel-rs/lintel/actions/workflows/ci.yml/badge.svg)](https://github.com/lintel-rs/lintel/actions/workflows/ci.yml)
[![License](https://img.shields.io/crates/l/lintel-schema-cache.svg)](https://github.com/lintel-rs/lintel/blob/master/LICENSE)

Disk-backed cache for JSON Schema files. Fetches schemas over HTTP and stores them locally for fast subsequent lookups.

## Features

- **Transparent caching** — schemas are stored as `<cache_dir>/<hash>.json` where `<hash>` is a deterministic hash of the URI
- **Pluggable HTTP** — bring your own HTTP client via the `HttpClient` trait, or use the built-in `UreqClient`
- **jsonschema integration** — implements both `jsonschema::Retrieve` and `jsonschema::AsyncRetrieve` for seamless use as a schema resolver

## Usage

```rust,no_run
use lintel_schema_cache::{SchemaCache, ReqwestClient};

let cache = SchemaCache::new(None, ReqwestClient::default(), false, None);
// Use cache.fetch(uri) to retrieve schemas — returns (Value, CacheStatus)
// CacheStatus: Hit (from disk), Miss (fetched and cached), or Disabled (no cache dir)
```

## Custom HTTP Client

```rust
use lintel_schema_cache::{SchemaCache, HttpClient};

#[derive(Clone)]
struct MyClient;

#[async_trait::async_trait]
impl HttpClient for MyClient {
    async fn get(&self, uri: &str) -> Result<String, Box<dyn std::error::Error + Send + Sync>> {
        // your HTTP implementation
        todo!()
    }
}

let cache = SchemaCache::new(None, MyClient, false, None);
```

## License

Apache-2.0