find.hpp

// Copyright 2014 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 <chrono>
#include <cstdint>

#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/string/view_or_value.hpp>
#include <mongocxx/cursor.hpp>
#include <mongocxx/hint.hpp>
#include <mongocxx/read_preference.hpp>

#include <mongocxx/config/prelude.hpp>

namespace mongocxx {
MONGOCXX_INLINE_NAMESPACE_BEGIN
namespace options {

class MONGOCXX_API find {
   public:
    find& allow_partial_results(bool allow_partial);

    const stdx::optional<bool>& allow_partial_results() const;

    find& batch_size(std::int32_t batch_size);

    const stdx::optional<std::int32_t>& batch_size() const;

    find& collation(bsoncxx::document::view_or_value collation);

    const stdx::optional<bsoncxx::document::view_or_value>& collation() const;

    find& comment(bsoncxx::string::view_or_value comment);

    const stdx::optional<bsoncxx::string::view_or_value>& comment() const;

    find& cursor_type(cursor::type cursor_type);

    const stdx::optional<cursor::type>& cursor_type() const;

    find& hint(class hint index_hint);

    const stdx::optional<class hint>& hint() const;

    find& limit(std::int64_t limit);

    const stdx::optional<std::int64_t>& limit() const;

    find& max(bsoncxx::document::view_or_value max);

    const stdx::optional<bsoncxx::document::view_or_value>& max() const;

    find& max_await_time(std::chrono::milliseconds max_await_time);

    const stdx::optional<std::chrono::milliseconds>& max_await_time() const;

    MONGOCXX_DEPRECATED find& max_scan(std::int64_t max);
    find& max_scan_deprecated(std::int64_t max);

    MONGOCXX_DEPRECATED const stdx::optional<std::int64_t>& max_scan() const;
    const stdx::optional<std::int64_t>& max_scan_deprecated() const;

    find& max_time(std::chrono::milliseconds max_time);

    const stdx::optional<std::chrono::milliseconds>& max_time() const;

    find& min(bsoncxx::document::view_or_value min);

    const stdx::optional<bsoncxx::document::view_or_value>& min() const;

    MONGOCXX_DEPRECATED find& modifiers(bsoncxx::document::view_or_value modifiers);
    find& modifiers_deprecated(bsoncxx::document::view_or_value modifiers);

    MONGOCXX_DEPRECATED const stdx::optional<bsoncxx::document::view_or_value>& modifiers() const;
    const stdx::optional<bsoncxx::document::view_or_value>& modifiers_deprecated() const;

    find& no_cursor_timeout(bool no_cursor_timeout);

    const stdx::optional<bool>& no_cursor_timeout() const;

    find& projection(bsoncxx::document::view_or_value projection);

    const stdx::optional<bsoncxx::document::view_or_value>& projection() const;

    find& read_preference(class read_preference rp);

    const stdx::optional<class read_preference>& read_preference() const;

    find& return_key(bool return_key);

    const stdx::optional<bool>& return_key() const;

    find& show_record_id(bool show_record_id);

    const stdx::optional<bool>& show_record_id() const;

    find& skip(std::int64_t skip);

    const stdx::optional<std::int64_t>& skip() const;

    MONGOCXX_DEPRECATED find& snapshot(bool snapshot);
    find& snapshot_deprecated(bool snapshot);

    MONGOCXX_DEPRECATED const stdx::optional<bool>& snapshot() const;
    const stdx::optional<bool>& snapshot_deprecated() const;

    find& sort(bsoncxx::document::view_or_value ordering);

    const stdx::optional<bsoncxx::document::view_or_value>& sort() const;

    MONGOCXX_PRIVATE find& modifiers_clear();

   private:
    stdx::optional<bool> _allow_partial_results;
    stdx::optional<std::int32_t> _batch_size;
    stdx::optional<bsoncxx::document::view_or_value> _collation;
    stdx::optional<bsoncxx::string::view_or_value> _comment;
    stdx::optional<cursor::type> _cursor_type;
    stdx::optional<class hint> _hint;
    stdx::optional<std::int64_t> _limit;
    stdx::optional<bsoncxx::document::view_or_value> _max;
    stdx::optional<std::chrono::milliseconds> _max_await_time;
    stdx::optional<std::int64_t> _max_scan;
    stdx::optional<std::chrono::milliseconds> _max_time;
    stdx::optional<bsoncxx::document::view_or_value> _min;
    stdx::optional<bsoncxx::document::view_or_value> _modifiers;
    stdx::optional<bool> _no_cursor_timeout;
    stdx::optional<bsoncxx::document::view_or_value> _projection;
    stdx::optional<class read_preference> _read_preference;
    stdx::optional<bool> _return_key;
    stdx::optional<bool> _show_record_id;
    stdx::optional<std::int64_t> _skip;
    stdx::optional<bool> _snapshot;
    stdx::optional<bsoncxx::document::view_or_value> _ordering;
};

}  // namespace options
MONGOCXX_INLINE_NAMESPACE_END
}  // namespace mongocxx

#include <mongocxx/config/postlude.hpp>