core/layers/foyer/README.md

# Apache OpenDAL™ Foyer Cache Layer

`opendal-layer-foyer` caches OpenDAL reads and writes in a Foyer hybrid cache.

## Use through `opendal`

Applications should normally enable this layer through the `opendal` facade with the
`layers-foyer` feature:

```shell
cargo add opendal --features layers-foyer
```

The layer is available as `opendal::layers::FoyerLayer` and can be
composed with an operator through `opendal::Operator::layer`.

## Use with `opendal-core`

Add the split crates directly:

```shell
cargo add opendal-core opendal-layer-foyer
```

Pass a configured layer to `Operator::layer`:

```rust
use opendal_core::Operator;
use opendal_layer_foyer::FoyerLayer;

fn add_layer(operator: Operator, layer: FoyerLayer) -> Operator {
    operator.layer(layer)
}
```

Construct and configure `layer` as described in the API documentation before
composing it with an operator.

## Documentation

- [Rust API documentation](https://docs.rs/opendal-layer-foyer)
- [Apache OpenDAL production guide](https://opendal.apache.org/docs/core/production)
- [Apache OpenDAL documentation](https://opendal.apache.org/docs/)

## License

Licensed under the Apache License, Version 2.0.