MongoDB C++ Driver  mongocxx-3.1.0
document.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 <bsoncxx/builder/basic/impl.hpp>
18 #include <bsoncxx/builder/basic/kvp.hpp>
19 #include <bsoncxx/builder/basic/sub_document.hpp>
20 #include <bsoncxx/builder/core.hpp>
21 #include <bsoncxx/document/value.hpp>
22 #include <bsoncxx/document/view.hpp>
23 
24 #include <bsoncxx/config/prelude.hpp>
25 
26 namespace bsoncxx {
27 BSONCXX_INLINE_NAMESPACE_BEGIN
28 namespace builder {
29 namespace basic {
30 
31 class array;
32 
37 class document : public sub_document {
38  public:
39  BSONCXX_INLINE document() : sub_document(&_core), _core(false) {
40  }
41 
45  BSONCXX_INLINE bsoncxx::document::view view() const {
46  return _core.view_document();
47  }
48 
55  BSONCXX_INLINE operator bsoncxx::document::view() const {
56  return view();
57  }
58 
68  BSONCXX_INLINE bsoncxx::document::value extract() {
69  return _core.extract_document();
70  }
71 
75  BSONCXX_INLINE void clear() {
76  _core.clear();
77  }
78 
79  private:
80  core _core;
81 };
82 
83 } // namespace basic
84 } // namespace builder
85 BSONCXX_INLINE_NAMESPACE_END
86 } // namespace bsoncxx
87 
88 #include <bsoncxx/config/postlude.hpp>
void clear()
Reset the underlying BSON to an empty document.
Definition: document.hpp:75
A low-level interface for constructing BSON documents and arrays.
Definition: core.hpp:42
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
void clear()
Delete the contents of the underlying BSON datum.
An internal class of builder::basic.
Definition: sub_document.hpp:38
bsoncxx::document::value extract()
Transfer ownership of the underlying document to the caller.
Definition: document.hpp:68
document::view view_document() const
Get a view over the document.
document::value extract_document()
Transfer ownership of the underlying document to the caller.
A traditional builder-style interface for constructing a BSON document.
Definition: document.hpp:37
Definition: element.hpp:24
bsoncxx::document::view view() const
Definition: document.hpp:45