MongoDB C++ Driver  mongocxx-3.0.1
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/document/view.hpp>
22 #include <bsoncxx/array/element.hpp>
23 
24 #include <bsoncxx/config/prelude.hpp>
25 
26 namespace bsoncxx {
27 BSONCXX_INLINE_NAMESPACE_BEGIN
28 namespace array {
29 
33 class BSONCXX_API view {
34  public:
35  class BSONCXX_API iterator;
36  class BSONCXX_API const_iterator;
37 
41  const_iterator cbegin() const;
42 
46  const_iterator cend() const;
47 
51  iterator begin() const;
52 
56  iterator end() const;
57 
68  iterator find(std::uint32_t i) const;
69 
80  element operator[](std::uint32_t i) const;
81 
86  view();
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 
149 class BSONCXX_API view::iterator : public std::iterator<std::forward_iterator_tag, element> {
150  public:
151  iterator();
152  explicit iterator(const element& element);
153 
154  reference operator*();
155  pointer operator->();
156 
157  iterator& operator++();
158  iterator operator++(int);
159 
167  friend BSONCXX_API bool BSONCXX_CALL operator==(const iterator&, const iterator&);
168  friend BSONCXX_API bool BSONCXX_CALL operator!=(const iterator&, const iterator&);
172 
173  private:
174  element _element;
175 };
176 
183 class BSONCXX_API view::const_iterator
184  : public std::iterator<std::forward_iterator_tag, element, std::ptrdiff_t, const element*,
185  const element&> {
186  public:
187  const_iterator();
188  explicit const_iterator(const element& element);
189 
190  reference operator*();
191  pointer operator->();
192 
193  const_iterator& operator++();
194  const_iterator operator++(int);
195 
203  friend BSONCXX_API bool BSONCXX_CALL operator==(const const_iterator&, const const_iterator&);
204  friend BSONCXX_API bool BSONCXX_CALL operator!=(const const_iterator&, const const_iterator&);
208 
209  private:
210  element _element;
211 };
212 
213 } // namespace array
214 BSONCXX_INLINE_NAMESPACE_END
215 } // namespace bsoncxx
216 
217 #include <bsoncxx/config/postlude.hpp>
A mutable iterator over the contents of an array view.
Definition: view.hpp:149
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
A const iterator over the contents of an array view.
Definition: view.hpp:183
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
A variant view type that accesses values in serialized BSON arrays.
Definition: element.hpp:36
Definition: element.hpp:24