Rincon is an ArangoDB driver for Rust. It enables low level access to ArangoDB in a typesafe and Rust idiomatic manner.
The name Rincon is derived from the Avocado variety list.
The vision for this project is to provide a fast and typesafe client lib for easy and flexible use of ArangoDB in applications.
Status: Experimental
The first usable version is released. Yuppie!
For details about this first version and how to use the Rincon ArangoDB driver see the README in the rincon crates subdirectory.
The project is continuously evolving. There may be breaking changes in upcoming releases. All changes will be documented in the CHANGELOG.md. Breaking changes will be marked as such.
If you are interested in using this Rincon ArangoDB driver I would be happy to receive feedback and here what everyone is thinking about it. Especially if you have ideas about improving usability of the driver.
Please file an issue on Github for every idea you have, the difficulties you are facing and naturally for all bugs you find.
You may also use the Gitter channel to ask questions and discuss things.
There is still lot of work todo. The next planned steps are:
-
Implement more operation of the ArangoDB REST API. Details about the planned and ready operations can be found in docs/arangodb_rest_api_methods.md
-
Implement the asynchronous session API (
rincon_session_async) -
Work on the documentation
The functionality of the Rincon ArangoDB Rust driver is split up into several crates for a modular design. This modular design enforces a clean code base. Applications can flexible combine the functionality they need by adding different combinations of the crates to their project. Developers can easily customize and extend the functionality of the existing crates.
For an overview of crates in this project see the README in the rincon crates subdirectory.
Each crate comes with its own README file which describes the purpose of the crate and how to use it.
Licensed under Apache License, Version 2.0
see LICENSE or http://www.apache.org/licenses/LICENSE-2.0 for details.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.