An ArangoDB driver for Rust
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
rincon rustfmt Jun 26, 2018
rincon_aql
rincon_client
rincon_connector rustfmt Jun 26, 2018
rincon_core
rincon_session rustfmt Jun 26, 2018
rincon_session_async rustfmt Jun 26, 2018
rincon_test_helper
.editorconfig Setup docker-compose for running ArangoDB in a Docker container. Sep 3, 2017
.env rename project to Rincon Nov 29, 2017
.gitignore
.travis.yml rename project to Rincon Nov 29, 2017
CHANGELOG.md rustfmt Jun 26, 2018
CODE_OF_CONDUCT.md
Cargo.toml separate crate for sync and async session Dec 28, 2017
LICENSE
README.md
appveyor.yml set path to msys64 for gnu builds in appveyor Nov 1, 2017
clippy.toml fix most clippy warnings Feb 11, 2018
docker-compose.yml
rustfmt.toml rustfmt Jun 26, 2018

README.md

Rincon

Crates.io Docs.rs Linux Build Status Windows Build Status codevoc.io Apache-2.0 Join the chat

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.

What's next?

There is still lot of work todo. The next planned steps are:

Multiple Crates

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.

License

Licensed under Apache License, Version 2.0
see LICENSE or http://www.apache.org/licenses/LICENSE-2.0 for details.

Contribution

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.