MongoDB C++ Driver  mongocxx-3.1.0
element.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <cstddef>
18 #include <cstdint>
19 
20 #include <bsoncxx/stdx/string_view.hpp>
21 
22 #include <bsoncxx/config/prelude.hpp>
23 
24 namespace bsoncxx {
25 BSONCXX_INLINE_NAMESPACE_BEGIN
26 
27 enum class type : std::uint8_t;
28 enum class binary_sub_type : std::uint8_t;
29 
30 namespace types {
31 struct b_eod;
32 struct b_double;
33 struct b_utf8;
34 struct b_document;
35 struct b_array;
36 struct b_binary;
37 struct b_undefined;
38 struct b_oid;
39 struct b_bool;
40 struct b_date;
41 struct b_null;
42 struct b_regex;
43 struct b_dbpointer;
44 struct b_code;
45 struct b_symbol;
46 struct b_codewscope;
47 struct b_int32;
48 struct b_timestamp;
49 struct b_int64;
50 struct b_decimal128;
51 struct b_minkey;
52 struct b_maxkey;
53 class value;
54 } // namespace types
55 
56 namespace array {
57 class element;
58 } // namespace array
59 
60 namespace document {
61 
71 class BSONCXX_API element {
72  public:
79  element();
80 
93  explicit element(const std::uint8_t* raw, std::uint32_t length, std::uint32_t offset);
94 
98  explicit operator bool() const;
99 
105  const std::uint8_t* raw() const;
106 
113  void raw(const std::uint8_t* raw);
114 
120  std::uint32_t length() const;
121 
128  void length(std::uint32_t length);
129 
135  std::uint32_t offset() const;
136 
143  void offset(std::uint32_t offset);
144 
152  bsoncxx::type type() const;
153 
161  stdx::string_view key() const;
162 
170  types::b_double get_double() const;
171 
179  types::b_utf8 get_utf8() const;
180 
188  types::b_document get_document() const;
189 
197  types::b_array get_array() const;
198 
206  types::b_binary get_binary() const;
207 
215  types::b_undefined get_undefined() const;
216 
224  types::b_oid get_oid() const;
225 
233  types::b_bool get_bool() const;
234 
242  types::b_date get_date() const;
243 
251  types::b_null get_null() const;
252 
260  types::b_regex get_regex() const;
261 
269  types::b_dbpointer get_dbpointer() const;
270 
278  types::b_code get_code() const;
279 
287  types::b_symbol get_symbol() const;
288 
296  types::b_codewscope get_codewscope() const;
297 
305  types::b_int32 get_int32() const;
306 
314  types::b_timestamp get_timestamp() const;
315 
323  types::b_int64 get_int64() const;
324 
332  types::b_decimal128 get_decimal128() const;
333 
341  types::b_minkey get_minkey() const;
342 
350  types::b_maxkey get_maxkey() const;
351 
358  types::value get_value() const;
359 
374  element operator[](stdx::string_view key) const;
375 
390  array::element operator[](std::uint32_t i) const;
391 
392  private:
393  const std::uint8_t* _raw;
394  std::uint32_t _length;
395  std::uint32_t _offset;
396 };
397 
398 } // namespace document
399 
400 BSONCXX_INLINE_NAMESPACE_END
401 } // namespace bsoncxx
402 
403 #include <bsoncxx/config/postlude.hpp>
A BSON signed 32-bit integer value.
Definition: types.hpp:532
A BSON double value.
Definition: types.hpp:85
A BSON Symbol value.
Definition: types.hpp:461
A BSON null value.
Definition: types.hpp:349
A BSON regex value.
Definition: types.hpp:365
A BSON binary data value.
Definition: types.hpp:205
A BSON DBPointer value.
Definition: types.hpp:401
A BSON max-key value.
Definition: types.hpp:652
A BSON UTF-8 encoded string value.
Definition: types.hpp:110
A BSON date value.
Definition: types.hpp:288
A BSON min-key value.
Definition: types.hpp:636
A BSON JavaScript code value.
Definition: types.hpp:420
A BSON JavaScript code with scope value.
Definition: types.hpp:499
A BSON 64-bit signed integer value.
Definition: types.hpp:580
A BSON replication timestamp value.
Definition: types.hpp:561
A BSON document value.
Definition: types.hpp:148
A variant view type that accesses values in serialized BSON documents.
Definition: element.hpp:71
A BSON boolean value.
Definition: types.hpp:263
A variant view type that accesses values in serialized BSON arrays.
Definition: element.hpp:36
A BSON ObjectId value.
Definition: types.hpp:245
Definition: element.hpp:24
A BSON undefined value.
Definition: types.hpp:229
A BSON array value.
Definition: types.hpp:180
A variant that can contain any BSON type.
Definition: value.hpp:37
A BSON Decimal128 value.
Definition: types.hpp:605