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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <string>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsontypes.h"
#include "mongo/stdx/functional.h"
namespace mongo {
class BSONObj;
class BSONElement;
class OID;
class Timestamp;
/**
* Finds an element named "fieldName" in "object".
*
* Returns Status::OK() and sets "*outElement" to the found element on success. Returns
* ErrorCodes::NoSuchKey if there are no matches.
*/
Status bsonExtractField(const BSONObj& object, StringData fieldName, BSONElement* outElement);
/**
* Finds an element named "fieldName" in "object".
*
* Returns Status::OK() and sets *outElement to the found element on success. Returns
* ErrorCodes::NoSuchKey if there are no matches for "fieldName", and ErrorCodes::TypeMismatch
* if the type of the matching element is not "type". For return values other than
* Status::OK(), the resulting value of "*outElement" is undefined.
*/
Status bsonExtractTypedField(const BSONObj& object,
StringData fieldName,
BSONType type,
BSONElement* outElement);
/**
* Finds a bool-like element named "fieldName" in "object".
*
* Returns Status::OK() and sets *out to the found element's boolean value on success. Returns
* ErrorCodes::NoSuchKey if there are no matches for "fieldName", and ErrorCodes::TypeMismatch
* if the type of the matching element is not Bool or a number type. For return values other
* than Status::OK(), the resulting value of "*out" is undefined.
*/
Status bsonExtractBooleanField(const BSONObj& object, StringData fieldName, bool* out);
/**
* Finds an element named "fieldName" in "object" that represents an integral value.
*
* Returns Status::OK() and sets *out to the element's 64-bit integer value representation on
* success. Returns ErrorCodes::NoSuchKey if there are no matches for "fieldName". Returns
* ErrorCodes::TypeMismatch if the value of the matching element is not of a numeric type.
* Returns ErrorCodes::BadValue if the value does not have an exact 64-bit integer
* representation. For return values other than Status::OK(), the resulting value of "*out" is
* undefined.
*/
Status bsonExtractIntegerField(const BSONObj& object, StringData fieldName, long long* out);
/**
* Finds an element named "fieldName" in "object" that represents a double-precision floating point
* value.
*
* Returns Status::OK() and sets *out to the element's double floating point value representation on
* success. Returns ErrorCodes::NoSuchKey if there are no matches for "fieldName". Returns
* ErrorCodes::TypeMismatch if the value of the matching element is not of a numeric type. Returns
* ErrorCodes::BadValue if the value does not have an exact floating point number representation.
* For return values other than Status::OK(), the resulting value of "*out" is undefined.
*/
Status bsonExtractDoubleField(const BSONObj& object, StringData fieldName, double* out);
/**
* Finds a string-typed element named "fieldName" in "object" and stores its value in "out".
*
* Returns Status::OK() and sets *out to the found element's std::string value on success. Returns
* ErrorCodes::NoSuchKey if there are no matches for "fieldName", and ErrorCodes::TypeMismatch
* if the type of the matching element is not String. For return values other than
* Status::OK(), the resulting value of "*out" is undefined.
*/
Status bsonExtractStringField(const BSONObj& object, StringData fieldName, std::string* out);
/**
* Finds an Timestamp-typed element named "fieldName" in "object" and stores its value in "out".
*
* Returns Status::OK() and sets *out to the found element's Timestamp value on success. Returns
* ErrorCodes::NoSuchKey if there are no matches for "fieldName", and ErrorCodes::TypeMismatch
* if the type of the matching element is not Timestamp. For return values other than
* Status::OK(), the resulting value of "*out" is undefined.
*/
Status bsonExtractTimestampField(const BSONObj& object, StringData fieldName, Timestamp* out);
/**
* Finds an OID-typed element named "fieldName" in "object" and stores its value in "out".
*
* Returns Status::OK() and sets *out to the found element's OID value on success. Returns
* ErrorCodes::NoSuchKey if there are no matches for "fieldName", and ErrorCodes::TypeMismatch
* if the type of the matching element is not OID. For return values other than Status::OK(),
* the resulting value of "*out" is undefined.
*/
Status bsonExtractOIDField(const BSONObj& object, StringData fieldName, OID* out);
/**
* Finds a bool-like element named "fieldName" in "object".
*
* If a field named "fieldName" is present, and is either a number or boolean type, stores the
* truth value of the field into "*out". If no field named "fieldName" is present, sets "*out"
* to "defaultValue". In these cases, returns Status::OK().
*
* If "fieldName" is present more than once, behavior is undefined. If the found field is not a
* boolean or number, returns ErrorCodes::TypeMismatch.
*/
Status bsonExtractBooleanFieldWithDefault(const BSONObj& object,
StringData fieldName,
bool defaultValue,
bool* out);
/**
* Finds an element named "fieldName" in "object" that represents an integral value.
*
* If a field named "fieldName" is present and is a value of numeric type with an exact 64-bit
* integer representation, returns that representation in *out and returns Status::OK(). If
* there is no field named "fieldName", stores defaultValue into *out and returns Status::OK().
* If the field is found, but has non-numeric type, returns ErrorCodes::TypeMismatch. If the
* value has numeric type, but cannot be represented as a 64-bit integer, returns
* ErrorCodes::BadValue.
*/
Status bsonExtractIntegerFieldWithDefault(const BSONObj& object,
StringData fieldName,
long long defaultValue,
long long* out);
/**
* Finds a double-precision floating point element named "fieldName" in "object".
*
* If a field named "fieldName" is present, and is a double, stores the value of the field into
* "*out". If no field named fieldName is present, sets "*out" to "defaultValue". In these cases,
* returns Status::OK().
*
* If "fieldName" is present more than once, behavior is undefined. If the found field is not a
* double, returns ErrorCodes::TypeMismatch.
*/
Status bsonExtractDoubleFieldWithDefault(const BSONObj& object,
StringData fieldName,
double defaultValue,
double* out);
/**
* Finds a std::string element named "fieldName" in "object".
*
* If a field named "fieldName" is present, and is a string, stores the value of the field into
* "*out". If no field named fieldName is present, sets "*out" to "defaultValue". In these
* cases, returns Status::OK().
*
* If "fieldName" is present more than once, behavior is undefined. If the found field is not a
* string, returns ErrorCodes::TypeMismatch.
*/
Status bsonExtractStringFieldWithDefault(const BSONObj& object,
StringData fieldName,
StringData defaultValue,
std::string* out);
/**
* Finds an OID-typed element named "fieldName" in "object" and stores its value in *out.
*
* Returns Status::OK() and sets *out to the found element's OID value on success. If no field
* named "fieldName" is present, *out is set to "defaultValue" and Status::OK() is returned.
* Returns ErrorCodes::TypeMismatch if the type of the matching element is not OID. For return
* values other than Status::OK(), the resulting value of *out is undefined.
*/
Status bsonExtractOIDFieldWithDefault(const BSONObj& object,
StringData fieldName,
const OID& defaultValue,
OID* out);
/**
* Finds an element named "fieldName" in "object" that represents an integral value for which
* 'pred' is true.
*
* If a field named "fieldName" is present and is a value of numeric type with an exact 64-bit
* integer representation, returns that representation in *out and returns Status::OK().
* If there is no field named "fieldName", stores defaultValue into *out and returns Status::OK().
* If the field is found, but has non-numeric type, returns ErrorCodes::TypeMismatch.
* If the value has numeric type, but cannot be represented as a 64-bit integer, returns BadValue.
* If the parsed value (or default) fails the predicate, returns ErrorCodes::BadValue.
*/
Status bsonExtractIntegerFieldWithDefaultIf(const BSONObj& object,
StringData fieldName,
long long defaultValue,
stdx::function<bool(long long)> pred,
const std::string& predDescription,
long long* out);
Status bsonExtractIntegerFieldWithDefaultIf(const BSONObj& object,
StringData fieldName,
long long defaultValue,
stdx::function<bool(long long)> pred,
long long* out);
} // namespace mongo
|
