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 <memory>
 
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/client_encryption-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/cursor-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/index_view-fwd.hpp>
#include <mongocxx/search_index_view-fwd.hpp>
 
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/stdx/optional.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class cursor {
   public:
    enum class type { k_non_tailable, k_tailable, k_tailable_await };
 
    class iterator;
 
    MONGOCXX_ABI_EXPORT_CDECL() cursor(cursor&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor&) operator=(cursor&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~cursor();
 
    cursor(const cursor&) = delete;
    cursor& operator=(const cursor&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL(iterator) begin();
 
    MONGOCXX_ABI_EXPORT_CDECL(iterator) end();
 
   private:
    friend ::mongocxx::v_noabi::client_encryption;
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::collection;
    friend ::mongocxx::v_noabi::database;
    friend ::mongocxx::v_noabi::index_view;
    friend ::mongocxx::v_noabi::search_index_view;
 
    friend ::mongocxx::v_noabi::cursor::iterator;
 
    cursor(void* cursor_ptr,
           bsoncxx::v_noabi::stdx::optional<type> cursor_type = bsoncxx::v_noabi::stdx::nullopt);
 
    class impl;
    std::unique_ptr<impl> _impl;
};
 
class cursor::iterator {
   public:
    using value_type = bsoncxx::v_noabi::document::view;
    using reference = bsoncxx::v_noabi::document::view&;
    using pointer = bsoncxx::v_noabi::document::view*;
    using iterator_category = std::input_iterator_tag;
    using difference_type = std::ptrdiff_t;
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::document::view&) operator*() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::document::view*) operator->() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(iterator&) operator++();
 
    MONGOCXX_ABI_EXPORT_CDECL(void) operator++(int);
 
   private:
    friend ::mongocxx::v_noabi::cursor;
 
    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(const iterator&, const iterator&);
    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(const iterator&, const iterator&);
 
    bool is_exhausted() const;
 
    explicit iterator(cursor* cursor);
 
    // If this pointer is null, the iterator is considered "past-the-end".
    cursor* _cursor;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>