mongod 0.3.6

An abstraction layer on mongodb
Documentation 
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use bson::Document;

use crate::error::Error;

//use crate::error::Error;

/// Used to create a mongo collection from a type.
///
/// This trait can be thought of as a collection's name along with its schema.
///
/// This trait is required in order to intract with the mongo [`Client`](`crate::Client`). The
/// implementation is used to tie a collection name to the chosen type while also defining how to
/// convert to and from a BSON [`Document`](`struct@bson::Document`).
///
/// # Examples
///
/// Defining a struct as a mongo document.
///
/// ```
/// use std::convert::TryFrom;
///
/// use mongod::bson::{self, Document};
/// use mongod::{Collection, Error};
/// use mongod::ext;
///
/// pub struct User {
///     pub name: String,
/// }
///
/// impl Collection for User {
///     const COLLECTION: &'static str = "users";
///     ///
///     fn from_document(document: Document) -> Result<Self, Error> {
///         let mut document = document;
///         let mut name: Option<String> = None;
///         if let Some(value) = document.remove("name") {
///             name = Some(String::try_from(ext::bson::Bson(value))?);
///         }
///         if name.is_none() {
///            return Err(Error::invalid_document("missing required fields"));
///         }
///         Ok(Self {
///             name: name.expect("could not get name"),
///         })
///     }
///
///     fn into_document(self) -> Result<Document, Error> {
///         let mut doc = Document::new();
///         doc.insert("name", self.name);
///         Ok(doc)
///     }
/// }
/// ```
pub trait Collection {
    /// The name of the collection to store the documents in.
    const COLLECTION: &'static str;

    /// Convert from a BSON `Document` into the `Collection`s type.
    fn from_document(document: Document) -> Result<Self, Error>
    where
        Self: Sized;
    /// Convert the `Collection`s type into a BSON `Document`.
    fn into_document(self) -> Result<Document, Error>;
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::bson::{self, Document};
    use crate::Error as MongoError;

    struct User {
        name: String,
    }

    impl Collection for User {
        const COLLECTION: &'static str = "users";

        fn from_document(document: Document) -> Result<Self, MongoError> {
            let mut document = document;
            let mut name: Option<String> = None;
            if let Some(value) = document.remove("name") {
                name = bson::from_bson(value).map_err(MongoError::invalid_document)?;
            }
            if name.is_none() {
                return Err(MongoError::invalid_document("missing required fields"));
            }
            Ok(User {
                name: name.expect("could not get name"),
            })
        }

        fn into_document(self) -> Result<Document, Error> {
            let mut doc = Document::new();
            doc.insert("name", self.name);
            Ok(doc)
        }
    }

    #[test]
    fn collection() {
        assert_eq!(User::COLLECTION, "users");
    }

    #[test]
    fn document_to_bson() {
        let user = User {
            name: "foo".to_owned(),
        };
        let doc = user.into_document().unwrap();
        assert_eq!(doc.get("name").unwrap().as_str().unwrap(), "foo".to_owned());
    }

    #[test]
    fn bson_to_document() {
        let mut doc = Document::new();
        doc.insert("name", "foo".to_owned());
        let user = User::from_document(doc).unwrap();
        assert_eq!(user.name, "foo".to_owned());
    }
}