MongoDB C++ Driver  mongocxx-3.4.0
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/types.hpp>
27 
28 #include <bsoncxx/config/prelude.hpp>
29 
30 namespace bsoncxx {
31 BSONCXX_INLINE_NAMESPACE_BEGIN
32 namespace builder {
33 
42 class BSONCXX_API core {
43  public:
44  class BSONCXX_PRIVATE impl;
45 
52  explicit core(bool is_array);
53 
54  core(core&& rhs) noexcept;
55  core& operator=(core&& rhs) noexcept;
56 
57  ~core();
58 
79  core& key_view(stdx::string_view key);
80 
94  core& key_owned(std::string key);
95 
107  core& open_document();
108 
120  core& open_array();
121 
131  core& close_document();
132 
142  core& close_array();
143 
161  core& concatenate(const document::view& view);
162 
175  core& append(const types::b_double& value);
176 
189  core& append(const types::b_utf8& value);
190 
203  core& append(const types::b_document& value);
204 
217  core& append(const types::b_array& value);
218 
231  core& append(const types::b_binary& value);
232 
245  core& append(const types::b_undefined& value);
246 
259  core& append(const types::b_oid& value);
260 
273  core& append(const types::b_bool& value);
274 
287  core& append(const types::b_date& value);
288 
301  core& append(const types::b_null& value);
302 
315  core& append(const types::b_regex& value);
316 
329  core& append(const types::b_dbpointer& value);
330 
343  core& append(const types::b_code& value);
344 
357  core& append(const types::b_symbol& value);
358 
371  core& append(const types::b_codewscope& value);
372 
385  core& append(const types::b_int32& value);
386 
399  core& append(const types::b_timestamp& value);
400 
413  core& append(const types::b_int64& value);
414 
427  core& append(const types::b_decimal128& value);
428 
441  core& append(const types::b_minkey& value);
442 
455  core& append(const types::b_maxkey& value);
456 
468  core& append(const types::value& value);
469 
481  core& append(std::string str);
482 
494  core& append(stdx::string_view str);
495 
509  template <typename T>
510  BSONCXX_INLINE core& append(T* v) {
511  static_assert(std::is_same<typename std::remove_const<T>::type, char>::value,
512  "append is disabled for non-char pointer types");
513  append(types::b_utf8{v});
514 
515  return *this;
516  }
517 
529  core& append(bool value);
530 
542  core& append(double value);
543 
555  core& append(std::int32_t value);
556 
568  core& append(std::int64_t value);
569 
581  core& append(const oid& value);
582 
594  core& append(decimal128 value);
595 
607  core& append(document::view view);
608 
620  core& append(array::view view);
621 
634  document::view view_document() const;
635 
647  array::view view_array() const;
648 
665  document::value extract_document();
666 
682  array::value extract_array();
683 
688  void clear();
689 
690  private:
691  std::unique_ptr<impl> _impl;
692 };
693 
694 } // namespace builder
695 BSONCXX_INLINE_NAMESPACE_END
696 } // namespace bsoncxx
697 
698 #include <bsoncxx/config/postlude.hpp>
A low-level interface for constructing BSON documents and arrays.
Definition: core.hpp:42
A BSON signed 32-bit integer value.
Definition: types.hpp:529
A BSON double value.
Definition: types.hpp:85
A BSON Symbol value.
Definition: types.hpp:457
A read-only BSON array that owns its underlying buffer.
Definition: value.hpp:34
Represents a MongoDB ObjectId.
Definition: oid.hpp:38
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
A BSON null value.
Definition: types.hpp:345
A BSON regex value.
Definition: types.hpp:361
A BSON binary data value.
Definition: types.hpp:203
A BSON DBPointer value.
Definition: types.hpp:399
A BSON max-key value.
Definition: types.hpp:648
A BSON UTF-8 encoded string value.
Definition: types.hpp:110
Represents an IEEE 754-2008 BSON Decimal128 value in a platform-independent way.
Definition: decimal128.hpp:30
A BSON date value.
Definition: types.hpp:286
A BSON min-key value.
Definition: types.hpp:632
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
A BSON JavaScript code value.
Definition: types.hpp:418
A BSON JavaScript code with scope value.
Definition: types.hpp:493
A BSON 64-bit signed integer value.
Definition: types.hpp:577
A BSON replication timestamp value.
Definition: types.hpp:558
A BSON document value.
Definition: types.hpp:146
A BSON boolean value.
Definition: types.hpp:261
A BSON ObjectId value.
Definition: types.hpp:243
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24
A BSON undefined value.
Definition: types.hpp:227
A BSON array value.
Definition: types.hpp:178
A variant that can contain any BSON type.
Definition: value.hpp:37
A BSON Decimal128 value.
Definition: types.hpp:602
core & append(T *v)
Appends a char* or const char*.
Definition: core.hpp:510