fcache 0.2.0

File caching library with lazy creation, automatic refresh, and callback-based initialization
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
48
49
50
51
52
53
54
55
56
57

# fcache

[![crates.io](https://img.shields.io/crates/v/fcache.svg?style=flat-square)](https://crates.io/crates/fcache)
[![Build](https://img.shields.io/github/actions/workflow/status/ventaquil/fcache/rust.yml?branch=master&style=flat-square&logo=github)](https://github.com/ventaquil/fcache/actions/workflows/rust.yml)
[![docs.rs](https://img.shields.io/docsrs/fcache?style=flat-square&logo=docsdotrs)](https://docs.rs/fcache/)
[![MSRV](https://img.shields.io/crates/msrv/fcache?style=flat-square)](https://github.com/ventaquil/fcache/blob/master/Cargo.toml)
[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square)](https://github.com/rust-secure-code/safety-dance)
[![LICENSE](https://img.shields.io/github/license/ventaquil/fcache?style=flat-square)](https://github.com/ventaquil/fcache/blob/master/LICENSE)

A Rust library for efficient file caching with a straightforward interface for creating, retrieving, and managing cached files efficiently.

## Setup

Add this to your `Cargo.toml`:

```toml
[dependencies]
fcache = "0.2.0"
```

Alternatively, you can use the [`cargo add`](https://doc.rust-lang.org/cargo/commands/cargo-add.html) subcommand:

```bash
cargo add fcache
```

## Usage

Use the library functions to create cache instances and manage files:

```rust
use fcache::prelude::*;

fn main() -> fcache::Result<()> {
    // Create a new cache instance
    let cache = fcache::new()?;

    // Create a file with callback
    let cache_file = cache.get("data.txt", |mut file| {
        file.write_all(b"Hello, World!")?;
        Ok(())
    })?;

    // Read from the file
    let mut content = String::new();
    cache_file.open()?.read_to_string(&mut content)?;
    println!("Content: {}", content);

    Ok(())
}
```

For more usage examples, refer to the documentation available at [docs.rs](https://docs.rs/fcache/).

## License

This crate is licensed under the MIT License.