MongoDB C++ Driver  mongocxx-3.0.1
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_minkey;
51 struct b_maxkey;
52 class value;
53 } // namespace types
54 
55 namespace array {
56 class element;
57 } // namespace array
58 
59 namespace document {
60 
70 class BSONCXX_API element {
71  public:
78  element();
79 
92  explicit element(const std::uint8_t* raw, std::uint32_t length, std::uint32_t offset);
93 
97  explicit operator bool() const;
98 
104  const std::uint8_t* raw() const;
105 
112  void raw(const std::uint8_t* raw);
113 
119  std::uint32_t length() const;
120 
127  void length(std::uint32_t length);
128 
134  std::uint32_t offset() const;
135 
142  void offset(std::uint32_t offset);
143 
149  bsoncxx::type type() const;
150 
156  stdx::string_view key() const;
157 
165  types::b_double get_double() const;
166 
174  types::b_utf8 get_utf8() const;
175 
183  types::b_document get_document() const;
184 
192  types::b_array get_array() const;
193 
201  types::b_binary get_binary() const;
202 
210  types::b_undefined get_undefined() const;
211 
219  types::b_oid get_oid() const;
220 
228  types::b_bool get_bool() const;
229 
237  types::b_date get_date() const;
238 
246  types::b_null get_null() const;
247 
255  types::b_regex get_regex() const;
256 
264  types::b_dbpointer get_dbpointer() const;
265 
273  types::b_code get_code() const;
274 
282  types::b_symbol get_symbol() const;
283 
291  types::b_codewscope get_codewscope() const;
292 
300  types::b_int32 get_int32() const;
301 
309  types::b_timestamp get_timestamp() const;
310 
318  types::b_int64 get_int64() const;
319 
327  types::b_minkey get_minkey() const;
328 
336  types::b_maxkey get_maxkey() const;
337 
344  types::value get_value() const;
345 
358  element operator[](stdx::string_view key) const;
359 
372  array::element operator[](std::uint32_t i) const;
373 
374  private:
375  const std::uint8_t* _raw;
376  std::uint32_t _length;
377  std::uint32_t _offset;
378 };
379 
380 } // namespace document
381 
382 BSONCXX_INLINE_NAMESPACE_END
383 } // namespace bsoncxx
384 
385 #include <bsoncxx/config/postlude.hpp>
A BSON signed 32-bit integer value.
Definition: types.hpp:538
A BSON double value.
Definition: types.hpp:84
A BSON JavaScript code value.
Definition: types.hpp:465
A BSON null value.
Definition: types.hpp:346
A BSON regex value.
Definition: types.hpp:366
A BSON binary data value.
Definition: types.hpp:202
A BSON DBPointer value.
Definition: types.hpp:402
A BSON max-key value.
Definition: types.hpp:635
A BSON UTF-8 encoded string value.
Definition: types.hpp:109
A BSON date value.
Definition: types.hpp:286
A BSON min-key value.
Definition: types.hpp:615
A BSON JavaScript code value.
Definition: types.hpp:425
A BSON JavaScript code with scope value.
Definition: types.hpp:505
A BSON 64-bit signed integer value.
Definition: types.hpp:586
A BSON replication timestamp value.
Definition: types.hpp:567
A BSON document value.
Definition: types.hpp:145
A variant view type that accesses values in serialized BSON documents.
Definition: element.hpp:70
A BSON boolean value.
Definition: types.hpp:261
A variant view type that accesses values in serialized BSON arrays.
Definition: element.hpp:36
A BSON ObjectId value.
Definition: types.hpp:243
Definition: element.hpp:24
A BSON undefined value.
Definition: types.hpp:227
A BSON array value.
Definition: types.hpp:177
A variant that can contain any BSON type.
Definition: value.hpp:37