MongoDB C++ Driver mongocxx-3.0.0
Loading...
Searching...
No Matches
array.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/array/view.hpp>
18#include <bsoncxx/array/value.hpp>
19#include <bsoncxx/builder/core.hpp>
20#include <bsoncxx/builder/stream/array_context.hpp>
21#include <bsoncxx/builder/stream/key_context.hpp>
22#include <bsoncxx/builder/stream/single_context.hpp>
23#include <bsoncxx/builder/stream/value_context.hpp>
24
25#include <bsoncxx/config/prelude.hpp>
26
27namespace bsoncxx {
28BSONCXX_INLINE_NAMESPACE_BEGIN
29namespace builder {
30namespace stream {
31
36class array : public array_context<> {
37 public:
38
42 BSONCXX_INLINE array() : array_context<>(&_core), _core(true) {
43 }
44
48 BSONCXX_INLINE bsoncxx::array::view view() const {
49 return _core.view_array();
50 }
51
55 BSONCXX_INLINE operator bsoncxx::array::view() const {
56 return view();
57 }
58
68 BSONCXX_INLINE bsoncxx::array::value extract() {
69 return _core.extract_array();
70 }
71
75 BSONCXX_INLINE void clear() {
76 _core.clear();
77 }
78
79 private:
80 core _core;
81};
82
83} // namespace stream
84} // namespace builder
85BSONCXX_INLINE_NAMESPACE_END
86} // namespace bsoncxx
87
88#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:33
A low-level interface for constructing BSON documents and arrays.
Definition core.hpp:42
array::view view_array() const
Get a view over the array.
array::value extract_array()
Transfer ownership of the underlying document to the caller.
void clear()
Delete the contents of the underlying BSON datum.
A stream context which expects any number of values.
Definition array_context.hpp:52
A streaming interface for constructing a BSON array.
Definition array.hpp:36
array()
Default constructor.
Definition array.hpp:42
void clear()
Reset the underlying BSON to an empty array.
Definition array.hpp:75
bsoncxx::array::view view() const
Definition array.hpp:48
bsoncxx::array::value extract()
Transfer ownership of the underlying array to the caller.
Definition array.hpp:68