История

Myk Melez 2c76682892 Bug 1527104 - use rkv::OwnedValue instead of internal OwnedValue in kvstore r=nika The kvstore crate that landed in bug 1490496 uses an internal implementation of OwnedValue because the rkv crate's equivalent was insufficient at the time that kvstore was being developed. rkv's OwnedValue has since evolved to support kvstore's use cases, and bug 1525392 is updating mozilla-central to the latest version of rkv; so we should replace kvstore's internal OwnedValue with rkv::OwnedValue. Differential Revision: https://phabricator.services.mozilla.com/D19436 --HG-- extra : moz-landing-system : lando		2019-02-15 18:33:30 +00:00
..
examples	Bug 1525392 - update rkv (and LMDB) to their latest stable versions r=froydnj	2019-02-11 19:53:28 +00:00
src	Bug 1527104 - use rkv::OwnedValue instead of internal OwnedValue in kvstore r=nika	2019-02-15 18:33:30 +00:00
tests	Bug 1525392 - update rkv (and LMDB) to their latest stable versions r=froydnj	2019-02-11 19:53:28 +00:00
.cargo-checksum.json	Bug 1527104 - use rkv::OwnedValue instead of internal OwnedValue in kvstore r=nika	2019-02-15 18:33:30 +00:00
Cargo.toml	Bug 1527104 - use rkv::OwnedValue instead of internal OwnedValue in kvstore r=nika	2019-02-15 18:33:30 +00:00
LICENSE	Bug 1445451 - vendor rkv; r=froydnj	2018-08-09 19:42:17 +00:00
README.md	Bug 1445451 - vendor rkv; r=froydnj	2018-08-09 19:42:17 +00:00
run-all-examples.sh	Bug 1445451 - vendor rkv; r=froydnj	2018-08-09 19:42:17 +00:00

README.md

rkv

The rkv Rust crate is a simple, humane, typed Rust interface to LMDB.

Use

Comprehensive information about using rkv is available in its online documentation, which you can also generate for local consumption:

cargo doc --open

Build

Build this project as you would build other Rust crates:

cargo build

If you specify the backtrace feature, backtraces will be enabled in failure errors. This feature is disabled by default.

Test

Test this project as you would test other Rust crates:

cargo test

The 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:

./run-all-examples.sh

Contribute

Of the various open source archetypes described in A Framework for Purposeful Open Source, 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 and submit pull requests for code and documentation changes.

rkv relies on the latest rustfmt for code formatting, so please make sure your pull request passes the rustfmt before submitting it for review. See rustfmt's quick start for installation details.

We follow Mozilla's Community Participation Guidelines while contributing to this project.

License

The rkv source code is licensed under the Apache License, Version 2.0, as described in the LICENSE file.