<p align="center"><img width="280px" src="https://raw.githubusercontent.com/meilisearch/heed/main/assets/heed-pigeon-logo.png"></a>
<h1 align="center" >heed</h1>
[](#LICENSE)
[](https://crates.io/crates/heed)
[](https://docs.rs/heed)
[](https://deps.rs/repo/github/meilisearch/heed)
[](https://github.com/meilisearch/heed/actions/workflows/rust.yml)
A fully typed [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database) wrapper with minimum overhead, uses bytemuck internally.
This library is able to serialize all kind of types, not just bytes slices, even _Serde_ types are supported.
Go check out [the examples](heed/examples/).
## Building from Source
If you don't already cloned the repository you can use this command:
```bash
git clone --recursive https://github.com/meilisearch/heed.git
cd heed
cargo build
```
However, if you already cloned it and forgot to initialize the submodules execute the follwing command:
```bash
git submodule update --init
```