MongoDB C++ Driver current
Loading...
Searching...
No Matches
core.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 <memory>
18#include <stdexcept>
19#include <type_traits>
20
21#include <bsoncxx/array/value.hpp>
22#include <bsoncxx/array/view.hpp>
23#include <bsoncxx/document/value.hpp>
24#include <bsoncxx/document/view.hpp>
25#include <bsoncxx/stdx/string_view.hpp>
26#include <bsoncxx/stdx/type_traits.hpp>
27#include <bsoncxx/types.hpp>
28
29#include <bsoncxx/config/prelude.hpp>
30
31namespace bsoncxx {
32inline namespace v_noabi {
33namespace builder {
34
43class BSONCXX_API core {
44 public:
45 class BSONCXX_PRIVATE impl;
46
53 explicit core(bool is_array);
54
55 core(core&& rhs) noexcept;
56 core& operator=(core&& rhs) noexcept;
57
58 ~core();
59
80 core& key_view(stdx::string_view key);
81
95 core& key_owned(std::string key);
96
109
122
133
144
163
177
191
205
218 core& append(const types::b_array& value);
219
233
247
260 core& append(const types::b_oid& value);
261
274 core& append(const types::b_bool& value);
275
288 core& append(const types::b_date& value);
289
302 core& append(const types::b_null& value);
303
316 core& append(const types::b_regex& value);
317
331
344 core& append(const types::b_code& value);
345
359
373
386 core& append(const types::b_int32& value);
387
401
414 core& append(const types::b_int64& value);
415
429
443
457
470
482 core& append(std::string str);
483
495 core& append(stdx::string_view str);
496
510 template <typename T>
511 BSONCXX_INLINE core& append(T* v) {
512 static_assert(detail::is_alike<T, char>::value,
513 "append is disabled for non-char pointer types");
514 append(types::b_string{v});
515
516 return *this;
517 }
518
530 core& append(bool value);
531
543 core& append(double value);
544
556 core& append(std::int32_t value);
557
569 core& append(std::int64_t value);
570
582 core& append(const oid& value);
583
596
609
622
636
649
667
684
689 void clear();
690
691 private:
692 std::unique_ptr<impl> _impl;
693};
694
695} // namespace builder
696} // namespace v_noabi
697} // namespace bsoncxx
698
699#include <bsoncxx/config/postlude.hpp>
A read-only BSON array that owns its underlying buffer.
Definition value.hpp:34
A read-only, non-owning view of a BSON document.
Definition view.hpp:39
A low-level interface for constructing BSON documents and arrays.
Definition core.hpp:43
core & append(const types::b_maxkey &value)
Appends a BSON max-key.
core & append(bool value)
Appends a native boolean as a BSON boolean.
void clear()
Deletes the contents of the underlying BSON datum.
core & append(const types::b_null &value)
Appends a BSON null.
core & append(const types::b_array &value)
Appends a BSON array.
core & append(double value)
Appends a native double as a BSON double.
core & append(const oid &value)
Appends an oid as a BSON ObjectId.
core & append(const types::b_minkey &value)
Appends a BSON min-key.
core & append(const types::b_decimal128 &value)
Appends a BSON Decimal128.
core & append(const types::b_codewscope &value)
Appends a BSON JavaScript code with scope.
document::value extract_document()
Transfers ownership of the underlying document to the caller.
core & append(const types::b_dbpointer &value)
Appends a BSON DBPointer.
core & append(T *v)
Appends a char* or const char*.
Definition core.hpp:511
core & append(std::string str)
Appends an STL string as a BSON UTF-8 string.
core & append(const types::b_document &value)
Appends a BSON document.
core & append(const types::b_int64 &value)
Appends a BSON 64-bit signed integer.
core & append(const types::bson_value::view &value)
Appends a BSON variant value.
core & append(const types::b_date &value)
Appends a BSON date.
core & append(decimal128 value)
Appends a decimal128 object as a BSON Decimal128.
core & append(std::int64_t value)
Appends a native int64_t as a BSON 64-bit signed integer.
core & key_owned(std::string key)
Appends a key passed as an STL string.
array::view view_array() const
Gets a view over the array.
core(bool is_array)
Constructs an empty BSON datum.
core & key_view(stdx::string_view key)
Appends a key passed as a non-owning stdx::string_view.
core & append(const types::b_double &value)
Appends a BSON double.
core & open_document()
Opens a sub-document within this BSON datum.
core & append(const types::b_timestamp &value)
Appends a BSON replication timestamp.
core & close_array()
Closes the current sub-array within this BSON datum.
core & append(const types::b_binary &value)
Appends a BSON binary datum.
core & append(const types::b_string &value)
Append a BSON UTF-8 string.
core & append(const types::b_bool &value)
Appends a BSON boolean.
core & append(const types::b_oid &value)
Appends a BSON ObjectId.
core & append(array::view view)
Appends the given array view.
core & append(std::int32_t value)
Appends a native int32_t as a BSON 32-bit signed integer.
core & append(const types::b_int32 &value)
Appends a BSON 32-bit signed integer.
core & append(stdx::string_view str)
Appends a string view as a BSON UTF-8 string.
core & open_array()
Opens a sub-array within this BSON datum.
core & append(const types::b_undefined &value)
Appends a BSON undefined.
document::view view_document() const
Gets a view over the document.
core & append(const types::b_code &value)
Appends a BSON JavaScript code.
core & append(document::view view)
Appends the given document view.
array::value extract_array()
Transfers ownership of the underlying document to the caller.
core & close_document()
Closes the current sub-document within this BSON datum.
core & append(const types::b_regex &value)
Appends a BSON regex.
core & concatenate(const document::view &view)
Appends the keys from a BSON document into this BSON datum.
core & append(const types::b_symbol &value)
Appends a BSON symbol.
Represents an IEEE 754-2008 BSON Decimal128 value in a platform-independent way.
Definition decimal128.hpp:29
A read-only BSON document that owns its underlying buffer.
Definition value.hpp:36
A read-only, non-owning view of a BSON document.
Definition view.hpp:33
Represents a MongoDB ObjectId.
Definition oid.hpp:37
A view-only variant that can contain any BSON type.
Definition view.hpp:44
The top-level namespace for bsoncxx library entities.
Definition element.hpp:24
A BSON array value.
Definition types.hpp:199
A BSON binary data value.
Definition types.hpp:224
A BSON boolean value.
Definition types.hpp:282
A BSON JavaScript code value.
Definition types.hpp:438
A BSON JavaScript code with scope value.
Definition types.hpp:509
A BSON date value.
Definition types.hpp:307
A BSON DBPointer value.
Definition types.hpp:419
A BSON Decimal128 value.
Definition types.hpp:612
A BSON document value.
Definition types.hpp:167
A BSON double value.
Definition types.hpp:101
A BSON signed 32-bit integer value.
Definition types.hpp:543
A BSON 64-bit signed integer value.
Definition types.hpp:587
A BSON max-key value.
Definition types.hpp:655
A BSON min-key value.
Definition types.hpp:639
A BSON null value.
Definition types.hpp:366
A BSON ObjectId value.
Definition types.hpp:264
A BSON regex value.
Definition types.hpp:382
A BSON UTF-8 encoded string value.
Definition types.hpp:126
A BSON Symbol value.
Definition types.hpp:475
A BSON replication timestamp value.
Definition types.hpp:568
A BSON undefined value.
Definition types.hpp:248