MongoDB C++ Driver 4.3.1
Loading...
Searching...
No Matches
value.hpp
Go to the documentation of this file.
1// Copyright 2009-present 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 <bsoncxx/document/value-fwd.hpp> // IWYU pragma: export
18
19//
20
22#include <bsoncxx/v1/document/value.hpp> // IWYU pragma: export
24
25#include <cstdint>
26#include <cstdlib>
27#include <memory>
28#include <type_traits>
29#include <utility>
30
34#include <bsoncxx/stdx/type_traits.hpp> // IWYU pragma: keep: backward compatibity, to be removed.
35
37
38namespace bsoncxx {
39namespace v_noabi {
40namespace document {
41
48class value {
49 public:
53 using deleter_type = void(BSONCXX_ABI_CDECL*)(std::uint8_t*);
54
58 using unique_ptr_type = std::unique_ptr<std::uint8_t[], deleter_type>;
59
60 private:
61 unique_ptr_type _data;
62 std::size_t _length{0};
63
64 public:
67
70
71 ~value() = default;
72
73 value(value&&) = default;
74 value& operator=(value&&) = default;
75
76 value(value const& other) : value{other.view()} {}
77
78 value& operator=(value const& other) {
79 *this = value{other.view()};
80 return *this;
81 }
82
100 value(std::uint8_t* data, std::size_t length, deleter_type deleter)
101 : _data{data, std::move(deleter)}, _length{length} {}
102
116 value(unique_ptr_type ptr, std::size_t length) : _data{std::move(ptr)}, _length{length} {}
117
127
139 template <typename T, detail::requires_not_t<int, std::is_same<T, array::view>> = 0>
140 explicit value(T const& t) : value({}) {
141 to_bson(t, *this);
142 }
143
154 template <typename T>
155 value& operator=(T const& t) {
156 *this = value{t};
157 return *this;
158 }
159
171 explicit operator v1::document::value() const& {
172 return v1::document::value{to_v1(this->view())};
173 }
174
186 explicit operator v1::document::value() && {
187 auto const length = _length;
188 _length = 0u;
189 return {_data.release(), length, std::move(_data.get_deleter())};
190 }
191
196 return this->view().cbegin();
197 }
198
203 return this->view().cend();
204 }
205
210 return this->view().begin();
211 }
212
217 return this->view().end();
218 }
219
222 return const_iterator{*this->view().find(key)};
223 }
224
236 return this->view().operator[](key);
237 }
238
244 std::uint8_t const* data() const {
245 return _data.get();
246 }
247
256 std::size_t size() const {
257 return _length; // Do NOT use this->view().size().
258 }
259
261 std::size_t length() const {
262 return _length; // Do NOT use this->view().length().
263 }
264
271 bool empty() const {
272 return _length == 5; // Do NOT use this->view().empty().
273 }
274
278 v_noabi::document::view view() const noexcept {
279 return {_data.get(), _length};
280 }
281
287 /* explicit(false) */ operator v_noabi::document::view() const noexcept {
288 return this->view();
289 }
290
298 template <typename T>
299 T get() {
300 T temp{};
301 from_bson(temp, this->view());
302 return temp;
303 }
304
314 template <typename T>
315 void get(T& t) {
316 from_bson(t, this->view());
317 }
318
329 return std::move(_data);
330 }
331
337 *this = value{view};
338 }
339};
340
345
347inline bool operator==(value const& lhs, value const& rhs) {
348 return (lhs.view() == rhs.view());
349}
350
352inline bool operator!=(value const& lhs, value const& rhs) {
353 return !(lhs == rhs);
354}
355
358
359} // namespace document
360} // namespace v_noabi
361} // namespace bsoncxx
362
363namespace bsoncxx {
364namespace v_noabi {
365
372
377
384
385} // namespace v_noabi
386} // namespace bsoncxx
387
388namespace bsoncxx {
389namespace document {
390
391using v_noabi::document::operator==;
392using v_noabi::document::operator!=;
393
394} // namespace document
395} // namespace bsoncxx
396
398
#define BSONCXX_ABI_CDECL
Expands to __cdecl when built with MSVC on Windows.
Definition export.hpp:49
#define BSONCXX_ABI_EXPORT_CDECL(...)
Equivalent to BSONCXX_ABI_EXPORT with BSONCXX_ABI_CDECL.
Definition export.hpp:52
The bsoncxx v_noabi macro guard postlude header.
The bsoncxx v_noabi macro guard prelude header.
A BSON document.
Definition value.hpp:46
v1::document::view view() const
Return a view of the BSON bytes as a document.
Definition value.hpp:377
A polyfill for std::string_view.
Definition string_view.hpp:412
A variant view type that accesses values in serialized BSON documents.
Definition element.hpp:52
A read-only BSON document that owns its underlying buffer.
Definition value.hpp:48
void( *)(std::uint8_t *) deleter_type
The type of the deleter used to free the underlying BSON binary data.
Definition value.hpp:53
std::uint8_t const * data() const
Access the raw bytes of the underlying document.
Definition value.hpp:244
T get()
Constructs an object of type T from this document object. This method uses argument-dependent lookup ...
Definition value.hpp:299
std::size_t length() const
Gets the length of the underlying buffer.
Definition value.hpp:261
value(unique_ptr_type ptr, std::size_t length)
Constructs a value from a std::unique_ptr to a buffer. The ownership of the buffer is transferred to ...
Definition value.hpp:116
bool operator==(value const &lhs, value const &rhs)
Compares two document values for (in)-equality.
Definition value.hpp:347
const_iterator find(v1::stdx::string_view key) const
Finds the first element of the document with the provided key. If there is no such element,...
Definition value.hpp:221
v_noabi::document::view view() const noexcept
Get a view over the document owned by this value.
Definition value.hpp:278
const_iterator cbegin() const
Definition value.hpp:195
bool empty() const
Return true when this->length() == 5.
Definition value.hpp:271
const_iterator cend() const
Definition value.hpp:202
unique_ptr_type release()
Transfer ownership of the underlying buffer to the caller.
Definition value.hpp:328
void get(T &t)
Constructs an object of type T from this document object. This method uses argument-dependent lookup ...
Definition value.hpp:315
void reset(v_noabi::document::view view)
Replace the formerly-owned buffer with the new view. This will make a copy of the passed-in view.
Definition value.hpp:336
std::size_t size() const
Gets the length of the underlying buffer.
Definition value.hpp:256
std::unique_ptr< std::uint8_t[], deleter_type > unique_ptr_type
The type of the unique pointer used to manage the underlying BSON binary data.
Definition value.hpp:58
const_iterator begin() const
Definition value.hpp:209
v_noabi::document::element operator[](v1::stdx::string_view key) const
Finds the first element of the document with the provided key. If there is no such element,...
Definition value.hpp:235
value(std::uint8_t *data, std::size_t length, deleter_type deleter)
Constructs a value from a buffer.
Definition value.hpp:100
bool operator!=(value const &lhs, value const &rhs)
Compares two document values for (in)-equality.
Definition value.hpp:352
v_noabi::document::view::const_iterator const_iterator
A const iterator over the contents of a document view.
Definition value.hpp:66
const_iterator end() const
Definition value.hpp:216
value & operator=(T const &t)
Assignment used for serialization of user objects. This uses argument-dependent lookup to find the fu...
Definition value.hpp:155
const_iterator iterator
Equivalent to const_iterator.
Definition value.hpp:69
A const iterator over the contents of a document view.
Definition view.hpp:205
A read-only, non-owning view of a BSON document.
Definition view.hpp:40
const_iterator find(v1::stdx::string_view key) const
Finds the first element of the document with the provided key. If there is no such element,...
const_iterator cend() const
Definition view.hpp:260
const_iterator begin() const
Definition view.hpp:264
const_iterator end() const
Definition view.hpp:268
const_iterator cbegin() const
Provides bsoncxx::v_noabi::document::element.
Declares entities representing a BSON document.
Declares entities representing a BSON array.
Declares entities representing a BSON document.
Declares entities whose ABI stability is NOT guaranteed.
v1::element::view to_v1(v_noabi::array::element const &v)
Convert to the bsoncxx::v1 equivalent of v.
Definition element.hpp:132
v_noabi::array::value from_v1(v1::array::value const &v)
Convert from the bsoncxx::v1 equivalent of v.
Definition value.hpp:263
The top-level namespace within which all bsoncxx library entities are declared.
For internal use only!
Provides bsoncxx::v1::document::value.
Provides std::string_view-related polyfills for library API usage.
Provides bsoncxx::v_noabi::array::view.
Declares bsoncxx::v_noabi::document::value.
Provides bsoncxx::v_noabi::document::view.
For internal use only!