MongoDB C++ Driver current
Loading...
Searching...
No Matches
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/document/element.hpp>
21
22#include <bsoncxx/config/prelude.hpp>
23
24namespace bsoncxx {
25BSONCXX_INLINE_NAMESPACE_BEGIN
26
27namespace types {
28namespace bson_value {
29class view;
30} // namespace bson_value
31} // namespace types
32
33namespace array {
34
42class BSONCXX_API element : private document::element {
43 public:
44 element();
45
46 using document::element::operator bool;
47
48 using document::element::type;
49
50 using document::element::get_array;
51 using document::element::get_binary;
52 using document::element::get_bool;
53 using document::element::get_code;
54 using document::element::get_codewscope;
55 using document::element::get_date;
56 using document::element::get_dbpointer;
57 using document::element::get_decimal128;
58 using document::element::get_document;
59 using document::element::get_double;
60 using document::element::get_int32;
61 using document::element::get_int64;
62 using document::element::get_maxkey;
63 using document::element::get_minkey;
64 using document::element::get_null;
65 using document::element::get_oid;
66 using document::element::get_regex;
67 using document::element::get_string;
68 using document::element::get_symbol;
69 using document::element::get_timestamp;
70 using document::element::get_undefined;
71 using document::element::get_utf8;
72
73 using document::element::get_value;
74
75 using document::element::operator[];
76
77 using document::element::key;
78 using document::element::keylen;
79 using document::element::length;
80 using document::element::offset;
81 using document::element::raw;
82
83 private:
84 friend class view;
85
86 BSONCXX_PRIVATE explicit element(const std::uint8_t* raw,
87 std::uint32_t length,
88 std::uint32_t offset,
89 std::uint32_t keylen);
90};
91
101BSONCXX_API bool BSONCXX_CALL operator==(const element& elem, const types::bson_value::view& v);
102BSONCXX_API bool BSONCXX_CALL operator==(const types::bson_value::view& v, const element& elem);
106
116BSONCXX_API bool BSONCXX_CALL operator!=(const element& elem, const types::bson_value::view& v);
117BSONCXX_API bool BSONCXX_CALL operator!=(const types::bson_value::view& v, const element& elem);
121
122} // namespace array
123
124BSONCXX_INLINE_NAMESPACE_END
125} // namespace bsoncxx
126
127#include <bsoncxx/config/postlude.hpp>
A variant view type that accesses values in serialized BSON arrays.
Definition element.hpp:42
bool operator==(const element &elem, const types::bson_value::view &v)
Convenience methods to compare for equality against a bson_value.
bool operator!=(const element &elem, const types::bson_value::view &v)
Convenience methods to compare for equality against a bson_value.
A read-only, non-owning view of a BSON document.
Definition view.hpp:40
A variant view type that accesses values in serialized BSON documents.
Definition element.hpp:76
A view-only variant that can contain any BSON type.
Definition view.hpp:44
Top level namespace for MongoDB C++ BSON functionality.
Definition element.hpp:24