view.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <iterator>
 
#include <bsoncxx/document/view-fwd.hpp>
 
#include <bsoncxx/document/element.hpp>
#include <bsoncxx/stdx/string_view.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
namespace bsoncxx {
namespace v_noabi {
namespace document {
 
class view {
   public:
    class const_iterator;
    using iterator = const_iterator;
 
    BSONCXX_ABI_EXPORT_CDECL() view();
 
    BSONCXX_ABI_EXPORT_CDECL() view(const std::uint8_t* data, std::size_t length);
 
    BSONCXX_ABI_EXPORT_CDECL(const_iterator) cbegin() const;
 
    BSONCXX_ABI_EXPORT_CDECL(const_iterator) cend() const;
 
    BSONCXX_ABI_EXPORT_CDECL(const_iterator) begin() const;
 
    BSONCXX_ABI_EXPORT_CDECL(const_iterator) end() const;
 
    BSONCXX_ABI_EXPORT_CDECL(const_iterator) find(stdx::string_view key) const;
 
    BSONCXX_ABI_EXPORT_CDECL(element) operator[](stdx::string_view key) const;
 
    BSONCXX_ABI_EXPORT_CDECL(const std::uint8_t*) data() const;
 
    BSONCXX_ABI_EXPORT_CDECL(std::size_t) length() const;
 
    BSONCXX_ABI_EXPORT_CDECL(bool) empty() const;
 
    friend BSONCXX_ABI_EXPORT_CDECL(bool) operator==(view, view);
    friend BSONCXX_ABI_EXPORT_CDECL(bool) operator!=(view, view);
 
   private:
    const std::uint8_t* _data;
    std::size_t _length;
};
 
class view::const_iterator {
   public:
    using value_type = element;
    using reference = element&;
    using pointer = element*;
    using iterator_category = std::forward_iterator_tag;
    using difference_type = std::ptrdiff_t;
 
    BSONCXX_ABI_EXPORT_CDECL() const_iterator();
    explicit BSONCXX_ABI_EXPORT_CDECL() const_iterator(const element& element);
 
    BSONCXX_ABI_EXPORT_CDECL(reference) operator*();
    BSONCXX_ABI_EXPORT_CDECL(pointer) operator->();
 
    BSONCXX_ABI_EXPORT_CDECL(const_iterator&) operator++();
    BSONCXX_ABI_EXPORT_CDECL(const_iterator) operator++(int);
 
    friend BSONCXX_ABI_EXPORT_CDECL(bool) operator==(const const_iterator&, const const_iterator&);
    friend BSONCXX_ABI_EXPORT_CDECL(bool) operator!=(const const_iterator&, const const_iterator&);
 
   private:
    element _element;
};
 
}  // namespace document
}  // namespace v_noabi
}  // namespace bsoncxx
 
#include <bsoncxx/config/postlude.hpp>