MongoDB C++ Driver current
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
49
72
74
75 using document::element::operator[];
76
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
types::b_regex get_regex() const
Getter for elements of the b_regex type.
types::b_timestamp get_timestamp() const
Getter for elements of the b_timestamp type.
bsoncxx::type type() const
Getter for the type of the element.
types::b_array get_array() const
Getter for elements of the b_array type.
types::b_codewscope get_codewscope() const
Getter for elements of the b_codewscope type.
types::bson_value::view get_value() const
Getter for a types::bson_value::view variant wrapper of the value portion of the element.
std::uint32_t length() const
Getter for length of the raw bson bytes the element points to.
stdx::string_view key() const
Getter for the element's key.
types::b_dbpointer get_dbpointer() const
Getter for elements of the b_dbpointer type.
types::b_date get_date() const
Getter for elements of the b_date type.
types::b_string get_string() const
Getter for elements of the b_string type.
types::b_minkey get_minkey() const
Getter for elements of the b_minkey type.
types::b_oid get_oid() const
Getter for elements of the b_oid type.
const std::uint8_t * raw() const
Getter for the raw bson bytes the element points to.
types::b_null get_null() const
Getter for elements of the b_null type.
std::uint32_t keylen() const
Getter for the element's key length.
types::b_symbol get_symbol() const
Getter for elements of the b_symbol type.
types::b_code get_code() const
Getter for elements of the b_code type.
types::b_undefined get_undefined() const
Getter for elements of the b_undefined type.
types::b_int64 get_int64() const
Getter for elements of the b_int64 type.
std::uint32_t offset() const
Getter for the offset into the raw bson bytes the element points to.
types::b_decimal128 get_decimal128() const
Getter for elements of the b_decimal128 type.
BSONCXX_DEPRECATED types::b_string get_utf8() const
Getter for elements of the b_string type.
types::b_document get_document() const
Getter for elements of the b_document type.
types::b_bool get_bool() const
Getter for elements of the b_bool type.
types::b_binary get_binary() const
Getter for elements of the b_binary type.
types::b_int32 get_int32() const
Getter for elements of the b_int32 type.
types::b_double get_double() const
Getter for elements of the b_double type.
types::b_maxkey get_maxkey() const
Getter for elements of the b_maxkey type.
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