change_stream.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/change_stream-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/value-fwd.hpp>
 
#include <bsoncxx/v1/document/view.hpp>
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
#include <bsoncxx/v1/types/value.hpp>
#include <bsoncxx/v1/types/view.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <chrono>
#include <cstddef>
#include <cstdint>
#include <iterator>
#include <string>
 
namespace mongocxx {
namespace v1 {

class change_stream {
   private:
    class impl;
    void* _impl;
 
   public:
    class options;
 
    class iterator;

    MONGOCXX_ABI_EXPORT_CDECL() ~change_stream();

    MONGOCXX_ABI_EXPORT_CDECL() change_stream(change_stream&& other) noexcept;

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

    change_stream(change_stream const&) = delete;

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

    MONGOCXX_ABI_EXPORT_CDECL(iterator) begin();

    iterator end() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) get_resume_token() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::view) next();

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) try_next();
 
    class internal;
 
   private:
    /* explicit(false) */ change_stream(void* impl);
};

class change_stream::options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~options();

    MONGOCXX_ABI_EXPORT_CDECL() options(options&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() options(options const& other);

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

    MONGOCXX_ABI_EXPORT_CDECL() options();

    MONGOCXX_ABI_EXPORT_CDECL(options&) batch_size(std::int32_t v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::int32_t>) batch_size() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) collation(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) comment(bsoncxx::v1::types::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::types::view>) comment() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) full_document(std::string v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view>) full_document() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) full_document_before_change(std::string v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view>) full_document_before_change()
        const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) max_await_time(std::chrono::milliseconds v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::chrono::milliseconds>) max_await_time() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) resume_after(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) resume_after() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) start_after(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) start_after() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) start_at_operation_time(bsoncxx::v1::types::b_timestamp v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::types::b_timestamp>) start_at_operation_time()
        const;
 
    class internal;
};

class change_stream::iterator {
   private:
    void* _impl; // v1::change_stream
 
   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 change_stream::iterator change_stream::end() const {
    return {};
}
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>