mongor 0.1.10

Ergonomic MongoDB ODM
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

// Authors: Robert Lopez
// License: MIT (See `LICENSE.md`)

use super::Model;
use crate::{core::find::FindManyCursor, error::Error};
use mongodb::{
    bson::{doc, Document},
    options::*,
    results::{DeleteResult, UpdateResult},
    ClientSession,
};
use serde::{Deserialize, Serialize};

impl<D> Model<D>
where
    D: Serialize + for<'a> Deserialize<'a> + Send + Sync + Unpin,
{
    /// Returns all documents in `self.collection`.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut model: Model<D> = ...;
    ///
    /// let mut cursor = model.find_all(
    ///     None::<FindOptions>,
    ///     None::<&mut ClientSession>,
    /// ).await?;
    ///
    /// while let Some(document: D) = cursor.next().await? {
    ///     ...
    /// }
    /// ```
    pub async fn find_all(
        &self,
        options: Option<FindOptions>,
        session: Option<&mut ClientSession>,
    ) -> Result<FindManyCursor<D>, Error> {
        self.find_many(doc! {}, options, session).await
    }

    /// Updates all documents in `self.collection`.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut model: Model<D> = ...;
    ///
    /// let update_result: UpdateResult = model.update_all(
    ///     doc! { ... },
    ///     None::<UpdateOptions>,
    ///     None::<&mut ClientSession>,
    /// ).await?;
    /// ```
    pub async fn update_all(
        &self,
        update: Document,
        options: Option<UpdateOptions>,
        session: Option<&mut ClientSession>,
    ) -> Result<UpdateResult, Error> {
        self.update_many(doc! {}, update, options, session).await
    }

    /// Deletes all documents in `self.collection`.
    ///
    /// ---
    /// Example Usage:
    /// ```
    ///
    /// let mut model: Model<D> = ...;
    ///
    /// let delete_result: DeleteResult = model.delete_all(
    ///     None::<DeleteOptions>,
    ///     None::<&mut ClientSession>,
    /// ).await?;
    /// ```
    pub async fn delete_all(
        &self,
        options: Option<DeleteOptions>,
        session: Option<&mut ClientSession>,
    ) -> Result<DeleteResult, Error> {
        self.delete_many(doc! {}, options, session).await
    }
}