You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mongo-rust-driver/README.md

1.3 KiB

Mongo Rust Driver

About

Mongo Rust driver built on top of the Mongo C driver. This drivers aims to be a thin wrapper around the production-ready C driver, while providing a safe and ergonomic Rust interface that handles all the gnarly usage details of the C driver for you.

Bson encoding and decoding is handled by the bson crate, the bindings are generated using bindgen.

The API is experimental, it might change at any time.

Compatibility

The driver currently only builds on Unix, tested on Mac Os X and Linux so far. On Mac Os X you might need to set this environment var for building to work (see https://github.com/crabtw/rust-bindgen#building for details):

export DYLD_LIBRARY_PATH=/Library/Developer/CommandLineTools/usr/lib

Logging

All internal logging by mongoc is redirected to the macros in the log crate. See the log docs to configure output in your application.

Examples

See the tests directory for examples of how to use the driver.

Contributing

Contributions are very welcome, only the parts of the C driver we need have been wrapped so far. Please write a test for any behavior you add.