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
|
/* Copyright 2012 10gen Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <string>
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsontypes.h"
namespace mongo {
class BSONObj;
class BSONElement;
/**
* 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,
const 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,
const 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,
const 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,
const StringData& fieldName,
long long* 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 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,
const StringData& fieldName,
std::string* 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,
const 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,
const StringData& fieldName,
long long defaultValue,
long long* out);
/**
* Finds a 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,
const StringData& fieldName,
const StringData& defaultValue,
std::string* out);
} // namespace mongo
|
