• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

examples/H03-May-2022-272199

src/H03-May-2022-4,1452,836

tests/H03-May-2022-311205

.appveyor.ymlH A D18-Sep-2019986 3934

.cargo-checksum.jsonH A D03-May-202289 11

.cargo_vcs_info.jsonH A D01-Jan-197074 65

.gitignoreH A D12-Sep-201930 43

.rustfmt.tomlH A D07-Aug-2019107 54

.travis.ymlH A D25-Sep-20191.2 KiB4639

CODE_OF_CONDUCT.mdH A D07-Aug-2019691 1611

Cargo.lockH A D01-Jan-197032.5 KiB735652

Cargo.tomlH A D01-Jan-19701.9 KiB7661

Cargo.toml.orig-cargoH A D25-Sep-20191.2 KiB4641

LICENSEH A D07-Aug-201911.1 KiB203169

README.mdH A D07-Aug-20192.8 KiB5634

run-all-examples.shH A D07-Aug-2019264 1510

README.md

1[![Travis CI Build Status](https://travis-ci.org/mozilla/rkv.svg?branch=master)](https://travis-ci.org/mozilla/rkv)
2[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/lk936u5y5bi6qafb/branch/master?svg=true)](https://ci.appveyor.com/project/mykmelez/rkv/branch/master)
3[![Documentation](https://docs.rs/rkv/badge.svg)](https://docs.rs/rkv/)
4[![Crate](https://img.shields.io/crates/v/rkv.svg)](https://crates.io/crates/rkv)
5
6# rkv
7
8The [rkv Rust crate](https://crates.io/crates/rkv) is a simple, humane, typed Rust interface to [LMDB](http://www.lmdb.tech/doc/).
9
10## Use
11
12Comprehensive information about using rkv is available in its [online documentation](https://docs.rs/rkv/), which you can also generate for local consumption:
13
14```sh
15cargo doc --open
16```
17
18## Build
19
20Build this project as you would build other Rust crates:
21
22```sh
23cargo build
24```
25
26If you specify the `backtrace` feature, backtraces will be enabled in `failure`
27errors. This feature is disabled by default.
28
29## Test
30
31Test this project as you would test other Rust crates:
32
33```sh
34cargo test
35```
36
37The project includes unit and doc tests embedded in the `src/` files, integration tests in the `tests/` subdirectory, and usage examples in the `examples/` subdirectory. To ensure your changes don't break examples, also run them via the run-all-examples.sh shell script:
38
39```sh
40./run-all-examples.sh
41```
42
43Note: the test fixtures in the `tests/envs/` subdirectory aren't included in the package published to crates.io, so you must clone this repository in order to run the tests that depend on those fixtures or use the `rand` and `dump` executables to recreate them.
44
45## Contribute
46
47Of the various open source archetypes described in [A Framework for Purposeful Open Source](https://medium.com/mozilla-open-innovation/whats-your-open-source-strategy-here-are-10-answers-383221b3f9d3), the rkv project most closely resembles the Specialty Library, and we welcome contributions. Please report problems or ask questions using this repo's GitHub [issue tracker](https://github.com/mozilla/rkv/issues) and submit [pull requests](https://github.com/mozilla/rkv/pulls) for code and documentation changes.
48
49rkv relies on the latest [rustfmt](https://github.com/rust-lang-nursery/rustfmt) for code formatting, so please make sure your pull request passes the rustfmt before submitting it for review. See rustfmt's [quick start](https://github.com/rust-lang-nursery/rustfmt#quick-start) for installation details.
50
51We follow Mozilla's [Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/) while contributing to this project.
52
53## License
54
55The rkv source code is licensed under the Apache License, Version 2.0, as described in the [LICENSE](https://github.com/mozilla/rkv/blob/master/LICENSE) file.
56