1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
//! [](https://travis-ci.org/thedodd/wither) //! [](#) //! [](https://crates.io/crates/wither) //! [](https://docs.rs/wither) //! [](LICENSE) //! //! An ODM for MongoDB built upon the //! [mongo rust driver](https://github.com/mongodb-labs/mongo-rust-driver-prototype). Please ⭐ on //! [github](https://github.com/thedodd/wither)! //! //! A primary goal of this project is to provide a simple, sane & predictable interface into //! MongoDB based on data models. If at any point this system might get in your way, you have //! direct access to the underlying driver. //! //! This project makes use of `associated constants` as of `0.2.0`, so you will need to be //! running rust `>= 1.20`. //! //! **NOTE:** progress is being, but there is a lot more to be done! For the time being, there //! may be backwards incompatible releases made from minor version to minor version until the best //! patterns for this library are found. It would be best to pin to an exact version in your //! `Cargo.toml`. Any such backwards incompatible changes will be declared in the //! [changelog](https://github.com/thedodd/wither/master/CHANGELOG.md). //! //! Check out the [changelog](https://github.com/thedodd/wither/master/CHANGELOG.md) for more //! details on what has happened from release to release. //! //! ### getting started //! A minimal example of how you might define a model for a MongoDB collection. //! //! ```rust //! #[macro_use] //! extern crate bson; //! extern crate serde; //! #[macro_use(Serialize, Deserialize)] //! extern crate serde_derive; //! extern crate wither; //! //! #[derive(Serialize, Deserialize, Debug, Clone)] //! pub struct User { //! /// The user's unique ID. //! #[serde(rename = "_id", skip_serializing_if = "Option::is_none")] //! pub id: Option<bson::oid::ObjectId>, //! //! /// The user's unique email. //! pub email: String, //! } //! //! impl<'a> wither::Model<'a> for User { //! //! /// The name of this model's collection. //! const COLLECTION_NAME: &'static str = "users"; //! //! /// Implement the getter for the ID of a model instance. //! fn id(&self) -> Option<bson::oid::ObjectId> { //! return self.id.clone(); //! } //! //! /// Implement the setter for the ID of a model instance. //! fn set_id(&mut self, oid: bson::oid::ObjectId) { //! self.id = Some(oid); //! } //! } //! ``` //! //! #### logging //! This create uses the [rust standard logging facade](https://docs.rs/log/), and integrating it with another logging framework is usually quite simple. If you are using slog, check out the [slog-rs/stdlog](https://docs.rs/slog-stdlog/) create for easy integration. //! //! #### next steps //! Now you are ready to tackle some of the other important parts of the model lifecycle. Some //! additional items to look into: //! //! - [Model::sync](./model/index.html#sync) - sync your models with the backend. //! - [Model::indexes](./model/index.html#indexes) - define indexes for your models. //! - [Model::migrations](./model/index.html#migrations) - define migrations to be run against //! your models collections. //! //! Good luck on the path. #[macro_use(doc, bson)] extern crate bson; extern crate chrono; #[macro_use] extern crate log; extern crate mongodb; extern crate serde; pub mod migration; pub mod model; // Expose lower symbols in the top level module. pub use migration::{ IntervalMigration, Migration, }; pub use model::{ basic_index_options, Model, };