cursor.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 <mongocxx/v1/cursor-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/view-fwd.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <cstddef>
#include <iterator>
 
namespace mongocxx {
namespace v1 {

class cursor {
   private:
    class impl;
    void* _impl;
 
   public:
    enum class type {
        k_non_tailable,

        k_tailable,

        k_tailable_await,
    };
 
    class iterator;

    MONGOCXX_ABI_EXPORT_CDECL() ~cursor();

    MONGOCXX_ABI_EXPORT_CDECL() cursor(cursor&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(cursor&) operator=(cursor&& other) noexcept;

    cursor(cursor const&) = delete;

    cursor& operator=(cursor const&) = delete;

    MONGOCXX_ABI_EXPORT_CDECL(iterator) begin();

    iterator end() const;
 
    class internal;
 
   private:
    /* explicit(false) */ cursor(void* impl);
};

class cursor::iterator {
   private:
    void* _impl; // v1::cursor
 
   public:
    using iterator_category = std::input_iterator_tag;

    using value_type = bsoncxx::v1::document::view;

    using difference_type = std::ptrdiff_t;

    using pointer = value_type const*;

    using reference = value_type;

    MONGOCXX_ABI_EXPORT_CDECL() ~iterator();

    MONGOCXX_ABI_EXPORT_CDECL() iterator(iterator&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(iterator&) operator=(iterator&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() iterator(iterator const& other);

    MONGOCXX_ABI_EXPORT_CDECL(iterator&) operator=(iterator const& other);

    MONGOCXX_ABI_EXPORT_CDECL() iterator();

    MONGOCXX_ABI_EXPORT_CDECL(value_type) operator*() const;

    MONGOCXX_ABI_EXPORT_CDECL(pointer) operator->() const;

    MONGOCXX_ABI_EXPORT_CDECL(iterator&) operator++();

    iterator& operator++(int) {
        return this->operator++();
    }

    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(iterator const& lhs, iterator const& rhs);

    friend bool operator!=(iterator const& lhs, iterator const& rhs) {
        return !(lhs == rhs);
    }
 
    class internal;
 
   private:
    /* explicit(false) */ iterator(void* impl);
};
 
inline cursor::iterator cursor::end() const {
    return {};
}
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>