MongoDB C++ Driver mongocxx-3.6.7
view.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 <cstddef>
18#include <cstdint>
19#include <iterator>
20
21#include <bsoncxx/array/element.hpp>
22#include <bsoncxx/document/view.hpp>
23
24#include <bsoncxx/config/prelude.hpp>
25
26namespace bsoncxx {
27BSONCXX_INLINE_NAMESPACE_BEGIN
28namespace array {
29
33class BSONCXX_API view {
34 public:
35 class BSONCXX_API const_iterator;
37
42
47
52
57
68 const_iterator find(std::uint32_t i) const;
69
80 element operator[](std::uint32_t i) const;
81
87
97 view(const std::uint8_t* data, std::size_t length);
98
104 const std::uint8_t* data() const;
105
114 std::size_t length() const;
115
122 bool empty() const;
123
124 operator document::view() const;
125
133 friend BSONCXX_API bool BSONCXX_CALL operator==(view, view);
134 friend BSONCXX_API bool BSONCXX_CALL operator!=(view, view);
138
139 private:
140 document::view _view;
141};
142
149class BSONCXX_API view::const_iterator : public std::iterator<std::forward_iterator_tag,
150 element,
151 std::ptrdiff_t,
152 const element*,
153 const element&> {
154 public:
156 explicit const_iterator(const element& element);
157
158 reference operator*();
159 pointer operator->();
160
161 const_iterator& operator++();
162 const_iterator operator++(int);
163
171 friend BSONCXX_API bool BSONCXX_CALL operator==(const const_iterator&, const const_iterator&);
172 friend BSONCXX_API bool BSONCXX_CALL operator!=(const const_iterator&, const const_iterator&);
176
177 private:
178 element _element;
179};
180
181} // namespace array
182BSONCXX_INLINE_NAMESPACE_END
183} // namespace bsoncxx
184
185#include <bsoncxx/config/postlude.hpp>
A variant view type that accesses values in serialized BSON arrays.
Definition: element.hpp:36
A const iterator over the contents of an array view.
Definition: view.hpp:153
friend bool operator!=(const const_iterator &, const const_iterator &)
Compare two const_iterators for (in)-equality.
friend bool operator==(const const_iterator &, const const_iterator &)
Compare two const_iterators for (in)-equality.
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
const_iterator cend() const
friend bool operator==(view, view)
Compare two views for (in)-equality.
const_iterator cbegin() const
const std::uint8_t * data() const
Access the raw bytes of the underlying array.
bool empty() const
Checks if the underlying buffer is empty, i.e.
view(const std::uint8_t *data, std::size_t length)
Constructs a view from a buffer.
view()
Default constructs a view.
const_iterator find(std::uint32_t i) const
Indexes into this BSON array.
const_iterator begin() const
std::size_t length() const
Gets the length of the underlying buffer.
friend bool operator!=(view, view)
Compare two views for (in)-equality.
const_iterator end() const
element operator[](std::uint32_t i) const
Indexes into this BSON array.
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24