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/array/value-fwd.hpp> // IWYU pragma: export
18
19//
20
21#include <bsoncxx/v1/array/value.hpp> // IWYU pragma: export
22
23#include <cstdint>
24#include <cstdlib>
25#include <memory>
26#include <utility>
27
31
33
34namespace bsoncxx {
35namespace v_noabi {
36namespace array {
37
44class value {
45 public:
47 using deleter_type = void(BSONCXX_ABI_CDECL*)(std::uint8_t*);
48
50 using unique_ptr_type = std::unique_ptr<uint8_t[], deleter_type>;
51
52 private:
53 unique_ptr_type _data;
54 std::size_t _length{0};
55
56 public:
59
62
63 ~value() = default;
64
65 value(value&&) = default;
66 value& operator=(value&&) = default;
67
68 value(value const& other) : value{other.view()} {}
69
70 value& operator=(value const& other) {
71 *this = value{other.view()};
72 return *this;
73 }
74
92 value(std::uint8_t* data, std::size_t length, deleter_type deleter)
93 : _data{data, std::move(deleter)}, _length{length} {}
94
108 value(unique_ptr_type ptr, std::size_t length) : _data{std::move(ptr)}, _length{length} {}
109
119
131 explicit operator v1::array::value() const& {
132 return v1::array::value{to_v1(this->view())};
133 }
134
146 explicit operator v1::array::value() && {
147 auto const length = _length;
148 _length = 0u;
149 return {_data.release(), length, std::move(_data.get_deleter())};
150 }
151
156 return this->view().cbegin();
157 }
158
163 return this->view().cend();
164 }
165
170 return this->view().begin();
171 }
172
177 return this->view().end();
178 }
179
181 const_iterator find(std::uint32_t i) const {
182 return const_iterator{*this->view().find(i)};
183 }
184
186 v_noabi::document::element operator[](std::uint32_t i) const {
187 return to_v1(this->view()).operator[](i);
188 }
189
191 std::uint8_t const* data() const {
192 return _data.get();
193 }
194
196 std::size_t size() const {
197 return _length; // Do NOT use _value.size().
198 }
199
201 std::size_t length() const {
202 return _length; // Do NOT use _value.length().
203 }
204
211 bool empty() const {
212 return _length == 5; // Do NOT use this->view().empty().
213 }
214
218 v_noabi::array::view view() const noexcept {
219 return {_data.get(), _length};
220 }
221
227 /* explicit(false) */ operator v_noabi::array::view() const noexcept {
228 return this->view();
229 }
230
241 return std::move(_data);
242 }
243
249 *this = value{view};
250 }
251};
252
253} // namespace array
254} // namespace v_noabi
255} // namespace bsoncxx
256
257namespace bsoncxx {
258namespace v_noabi {
259
266
274
279 return v1::array::value{std::move(v)};
280}
281
282} // namespace v_noabi
283} // namespace bsoncxx
284
286
#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 array.
Definition value.hpp:41
v1::array::view view() const
Return a view of the BSON bytes as an array.
Definition value.hpp:137
A read-only BSON array that owns its underlying buffer.
Definition value.hpp:44
std::unique_ptr< uint8_t[], deleter_type > unique_ptr_type
The type of the unique pointer used to manage the underlying BSON binary data.
Definition value.hpp:50
v_noabi::array::view::const_iterator const_iterator
A const iterator over the contents of a document view.
Definition value.hpp:58
void( *)(std::uint8_t *) deleter_type
The type of the deleter used to free the underlying BSON binary data.
Definition value.hpp:47
const_iterator cbegin() const
Definition value.hpp:155
const_iterator end() const
Definition value.hpp:176
unique_ptr_type release()
Transfer ownership of the underlying buffer to the caller.
Definition value.hpp:240
const_iterator find(std::uint32_t i) const
Indexes into this BSON array. If the index is out-of-bounds, a past-the-end iterator will be returned...
Definition value.hpp:181
v_noabi::array::view view() const noexcept
Get a view over the array owned by this value.
Definition value.hpp:218
std::size_t size() const
Gets the length of the underlying buffer in bytes.
Definition value.hpp:196
std::uint8_t const * data() const
Access the raw bytes of the underlying array.
Definition value.hpp:191
const_iterator cend() const
Definition value.hpp:162
bool empty() const
Return true when this->length() == 5.
Definition value.hpp:211
std::size_t length() const
Gets the length of the underlying buffer in bytes.
Definition value.hpp:201
const_iterator iterator
Equivalent to const_iterator.
Definition value.hpp:61
const_iterator begin() const
Definition value.hpp:169
void reset(v_noabi::array::view view)
Replace the formerly-owned buffer with the new view. This will make a copy of the passed-in view.
Definition value.hpp:248
value(std::uint8_t *data, std::size_t length, deleter_type deleter)
Constructs a value from a buffer.
Definition value.hpp:92
v_noabi::document::element operator[](std::uint32_t i) const
Indexes into this BSON array. If the index is out-of-bounds, the invalid array::element will be retur...
Definition value.hpp:186
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:108
A const iterator over the contents of an array view.
Definition view.hpp:174
A read-only, non-owning view of a BSON document.
Definition view.hpp:41
const_iterator begin() const
Definition view.hpp:233
const_iterator find(std::uint32_t i) const
Indexes into this BSON array. If the index is out-of-bounds, a past-the-end iterator will be returned...
const_iterator cend() const
Definition view.hpp:229
const_iterator cbegin() const
const_iterator end() const
Definition view.hpp:237
A variant view type that accesses values in serialized BSON documents.
Definition element.hpp:52
Provides bsoncxx::v_noabi::document::element.
Declares entities whose ABI stability is guaranteed for documented symbols.
Declares entities representing a BSON array.
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.
Provides bsoncxx::v1::array::value.
Declares bsoncxx::v_noabi::array::value.
Provides bsoncxx::v_noabi::array::view.
Provides bsoncxx::v_noabi::document::value.