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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
// Authors: Robert Lopez
// License: MIT (See `LICENSE.md`)
use super::Model;
use crate::{
core::{delete::*, find::*, replace::*, update::*},
error::Error,
};
use mongodb::{
bson::{doc, oid::ObjectId, Document},
options::*,
results::{DeleteResult, UpdateResult},
ClientSession,
};
use serde::{Deserialize, Serialize};
impl<D> Model<D>
where
D: Serialize + for<'a> Deserialize<'a> + Send + Sync + Unpin,
{
/// Executes a `findOne` query on `self.collection` by the `_id` field.
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.findOne/
///
/// ---
/// Example Usage:
/// ```
///
/// let oid: ObjectId = ...;
///
/// let mut model: Model<D> = ...;
///
/// let document_option: Option<D> = model.find_one_by_oid(
/// &oid,
/// None::<FindOneOptions>,
/// None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn find_one_by_oid(
&self,
oid: &ObjectId,
options: Option<FindOneOptions>,
session: Option<&mut ClientSession>,
) -> Result<Option<D>, Error> {
find_one(&self.collection, doc! { "_id": oid }, options, session).await
}
/// Executes a `deleteOne` query on `self.collection` by the `_id` field.
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.deleteOne/
///
/// ---
/// Example Usage:
/// ```
///
/// let oid: ObjectId = ...;
///
/// let mut model: Model<D> = ...;
///
/// let deletion_result: DeleteResult = model.delete_one_by_oid(
/// &oid,
/// None::<DeleteOptions>,
/// None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn delete_one_by_oid(
&self,
oid: &ObjectId,
options: Option<DeleteOptions>,
session: Option<&mut ClientSession>,
) -> Result<DeleteResult, Error> {
delete_one(&self.collection, doc! { "_id": oid }, options, session).await
}
/// Executes a `updateOne` query on `self.collection` by the `_id` field.
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.updateOne/
///
/// ---
/// Example Usage:
/// ```
///
/// let oid: ObjectId = ...;
///
/// let mut model: Model<D> = ...;
///
/// let update_result: UpdateResult = model.update_one_by_oid(
/// &oid,
/// doc! { ... },
/// None::<UpdateOptions>,
/// None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn update_one_by_oid(
&self,
oid: &ObjectId,
update: Document,
options: Option<UpdateOptions>,
session: Option<&mut ClientSession>,
) -> Result<UpdateResult, Error> {
update_one(
&self.collection,
doc! { "_id": oid },
update,
options,
session,
)
.await
}
/// Executes a `findOneAndUpdate` query on `self.collection`
/// by the `_id` field, returns the original document by default.
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.findOneAndUpdate/
///
/// ---
/// Example Usage:
/// ```
///
/// let oid: ObjectId = ...;
///
/// let mut model: Model<D> = ...;
///
/// let updated_document: Option<D> = model.find_one_and_update_by_oid(
/// &oid,
/// doc! { ... },
/// None::<FindOneAndUpdateOptions>,
/// None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn find_one_and_update_by_oid(
&self,
oid: &ObjectId,
update: Document,
options: Option<FindOneAndUpdateOptions>,
session: Option<&mut ClientSession>,
) -> Result<Option<D>, Error> {
find_one_and_update(
&self.collection,
doc! { "_id": oid },
update,
options,
session,
)
.await
}
/// Executes a `findOneAndReplace` query on `self.collection`
/// by the `_id` field, returns the original document by default.
///
/// https://www.mongodb.com/docs/manual/reference/method/db.collection.findOneAndReplace/
///
/// ---
/// Example Usage:
/// ```
///
/// let oid: ObjectId = ...;
///
/// let mut model: Model<D> = ...;
///
/// let replacement: D = ...;
///
/// let original_document: Option<D> = model.find_one_and_replace_by_oid(
/// &oid,
/// replacement,
/// None::<FindOneAndReplaceOptions>,
/// None::<&mut ClientSession>,
/// ).await?;
/// ```
pub async fn find_one_and_replace_by_oid(
&self,
oid: &ObjectId,
replacement: D,
options: Option<FindOneAndReplaceOptions>,
session: Option<&mut ClientSession>,
) -> Result<Option<D>, Error> {
find_one_and_replace(
&self.collection,
doc! { "_id": oid },
replacement,
options,
session,
)
.await
}
/// Returns if a document exists by a oid in `self.collection`.
///
/// ---
/// Example Usage:
/// ```
///
/// let model: Model<D> = ...;
///
/// let oid: ObjectId = ...;
///
/// if model.exists_by_oid(
/// &oid,
/// None::<FindOneOptions>,
/// None::<&mut ClientSession>,
/// ).await? {
/// ...
/// }
/// ```
pub async fn exists_by_oid(
&self,
oid: &ObjectId,
options: Option<FindOneOptions>,
session: Option<&mut ClientSession>,
) -> Result<bool, Error> {
Ok(self.find_one_by_oid(oid, options, session).await?.is_some())
}
}