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/document/element.hpp>
22#include <bsoncxx/stdx/string_view.hpp>
23
24#include <bsoncxx/config/prelude.hpp>
25
26namespace bsoncxx {
27BSONCXX_INLINE_NAMESPACE_BEGIN
28namespace document {
29
33class BSONCXX_API view {
34 public:
35 class BSONCXX_API const_iterator;
37
43
53 view(const std::uint8_t* data, std::size_t length);
54
59
64
69
74
90 const_iterator find(stdx::string_view key) const;
91
102 element operator[](stdx::string_view key) const;
103
109 const std::uint8_t* data() const;
110
119 std::size_t length() const;
120
127 bool empty() const;
128
136 friend BSONCXX_API bool BSONCXX_CALL operator==(view, view);
137 friend BSONCXX_API bool BSONCXX_CALL operator!=(view, view);
141
142 private:
143 const std::uint8_t* _data;
144 std::size_t _length;
145};
146
153class BSONCXX_API view::const_iterator : public std::iterator<std::forward_iterator_tag,
154 element,
155 std::ptrdiff_t,
156 const element*,
157 const element&> {
158 public:
160 explicit const_iterator(const element& element);
161
162 reference operator*();
163 pointer operator->();
164
165 const_iterator& operator++();
166 const_iterator operator++(int);
167
175 friend BSONCXX_API bool BSONCXX_CALL operator==(const const_iterator&, const const_iterator&);
176 friend BSONCXX_API bool BSONCXX_CALL operator!=(const const_iterator&, const const_iterator&);
180
181 private:
182 element _element;
183};
184
185} // namespace document
186BSONCXX_INLINE_NAMESPACE_END
187} // namespace bsoncxx
188
189#include <bsoncxx/config/postlude.hpp>
A variant view type that accesses values in serialized BSON documents.
Definition: element.hpp:76
A const iterator over the contents of a document view.
Definition: view.hpp:157
friend bool operator!=(const const_iterator &, const const_iterator &)
Compares two const_iterators for (in)-equality.
friend bool operator==(const const_iterator &, const const_iterator &)
Compares two const_iterators for (in)-equality.
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
const std::uint8_t * data() const
Access the raw bytes of the underlying document.
const_iterator cbegin() const
friend bool operator==(view, view)
Compare two document views for (in)-equality.
const_iterator find(stdx::string_view key) const
Finds the first element of the document with the provided key.
view()
Default constructs a view.
view(const std::uint8_t *data, std::size_t length)
Constructs a view from a buffer.
const_iterator end() const
std::size_t length() const
Gets the length of the underlying buffer.
bool empty() const
Checks if the underlying document is empty, i.e.
friend bool operator!=(view, view)
Compare two document views for (in)-equality.
const_iterator begin() const
element operator[](stdx::string_view key) const
Finds the first element of the document with the provided key.
const_iterator cend() const
Top level namespace for MongoDB C++ BSON functionality.
Definition: element.hpp:24