find.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/options/find-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/document/value.hpp>
 
#include <mongocxx/v1/cursor.hpp>
#include <mongocxx/v1/find_options.hpp> // IWYU pragma: export
 
#include <chrono>
#include <cstdint>
#include <utility>
 
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/string/view_or_value.hpp>
#include <bsoncxx/types/bson_value/value.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
#include <bsoncxx/types/bson_value/view_or_value.hpp>
 
#include <mongocxx/cursor.hpp>
#include <mongocxx/hint.hpp>
#include <mongocxx/read_preference.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace options {

class find {
   public:
    find() = default;

    /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() find(v1::find_options opts);

    explicit operator v1::find_options() const {
        using bsoncxx::v_noabi::to_v1;
        using mongocxx::v_noabi::to_v1;
 
        v1::find_options ret;
 
        if (_allow_disk_use) {
            ret.allow_disk_use(*_allow_disk_use);
        }
 
        if (_allow_partial_results) {
            ret.allow_partial_results(*_allow_partial_results);
        }
 
        if (_batch_size) {
            ret.batch_size(*_batch_size);
        }
 
        if (_collation) {
            ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
        }
 
        if (_cursor_type) {
            ret.cursor_type(static_cast<v1::cursor::type>(*_cursor_type));
        }
 
        if (_hint) {
            ret.hint(to_v1(*_hint));
        }
 
        if (_let) {
            ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
        }
 
        if (_comment_option) {
            ret.comment(bsoncxx::v1::types::value{to_v1(_comment_option->view())});
        } else if (_comment) {
            ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
        }
 
        if (_limit) {
            ret.limit(*_limit);
        }
 
        if (_max) {
            ret.max(bsoncxx::v1::document::value{to_v1(_max->view())});
        }
 
        if (_max_await_time) {
            ret.max_await_time(*_max_await_time);
        }
 
        if (_max_time) {
            ret.max_time(*_max_time);
        }
 
        if (_min) {
            ret.min(bsoncxx::v1::document::value{to_v1(_min->view())});
        }
 
        if (_no_cursor_timeout) {
            ret.no_cursor_timeout(*_no_cursor_timeout);
        }
 
        if (_projection) {
            ret.projection(bsoncxx::v1::document::value{to_v1(_projection->view())});
        }
 
        if (_read_preference) {
            ret.read_preference(to_v1(*_read_preference));
        }
 
        if (_return_key) {
            ret.return_key(*_return_key);
        }
 
        if (_show_record_id) {
            ret.show_record_id(*_show_record_id);
        }
 
        if (_skip) {
            ret.skip(*_skip);
        }
 
        if (_ordering) {
            ret.sort(bsoncxx::v1::document::value{to_v1(_ordering->view())});
        }
 
        return ret;
    }

    find& allow_disk_use(bool allow_disk_use) {
        _allow_disk_use = allow_disk_use;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bool> const& allow_disk_use() const {
        return _allow_disk_use;
    }

    find& allow_partial_results(bool allow_partial) {
        _allow_partial_results = allow_partial;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bool> const& allow_partial_results() const {
        return _allow_partial_results;
    }

    find& batch_size(std::int32_t batch_size) {
        _batch_size = batch_size;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<std::int32_t> const& batch_size() const {
        return _batch_size;
    }

    find& collation(bsoncxx::v_noabi::document::view_or_value collation) {
        _collation = std::move(collation);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& collation() const {
        return _collation;
    }

    find& comment(bsoncxx::v_noabi::string::view_or_value comment) {
        _comment = std::move(comment);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> const& comment() const {
        return _comment;
    }

    find& cursor_type(cursor::type cursor_type) {
        _cursor_type = cursor_type;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<cursor::type> const& cursor_type() const {
        return _cursor_type;
    }

    find& hint(v_noabi::hint index_hint) {
        _hint = std::move(index_hint);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<v_noabi::hint> const& hint() const {
        return _hint;
    }

    find& let(bsoncxx::v_noabi::document::view_or_value let) {
        _let = std::move(let);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const let() const {
        return _let;
    }

    find& comment_option(bsoncxx::v_noabi::types::bson_value::view_or_value comment) {
        _comment_option = std::move(comment);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> const& comment_option() const {
        return _comment_option;
    }

    find& limit(std::int64_t limit) {
        _limit = limit;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<std::int64_t> const& limit() const {
        return _limit;
    }

    find& max(bsoncxx::v_noabi::document::view_or_value max) {
        _max = std::move(max);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& max() const {
        return _max;
    }

    find& max_await_time(std::chrono::milliseconds max_await_time) {
        _max_await_time = max_await_time;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const& max_await_time() const {
        return _max_await_time;
    }

    find& max_time(std::chrono::milliseconds max_time) {
        _max_time = max_time;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const& max_time() const {
        return _max_time;
    }

    find& min(bsoncxx::v_noabi::document::view_or_value min) {
        _min = std::move(min);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& min() const {
        return _min;
    }

    find& no_cursor_timeout(bool no_cursor_timeout) {
        _no_cursor_timeout = no_cursor_timeout;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bool> const& no_cursor_timeout() const {
        return _no_cursor_timeout;
    }

    find& projection(bsoncxx::v_noabi::document::view_or_value projection) {
        _projection = std::move(projection);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& projection() const {
        return _projection;
    }

    find& read_preference(v_noabi::read_preference rp) {
        _read_preference = std::move(rp);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<v_noabi::read_preference> const& read_preference() const {
        return _read_preference;
    }

    find& return_key(bool return_key) {
        _return_key = return_key;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bool> const& return_key() const {
        return _return_key;
    }

    find& show_record_id(bool show_record_id) {
        _show_record_id = show_record_id;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bool> const& show_record_id() const {
        return _show_record_id;
    }

    find& skip(std::int64_t skip) {
        _skip = skip;
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<std::int64_t> const& skip() const {
        return _skip;
    }

    find& sort(bsoncxx::v_noabi::document::view_or_value ordering) {
        _ordering = std::move(ordering);
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& sort() const {
        return _ordering;
    }
 
   private:
    bsoncxx::v_noabi::stdx::optional<bool> _allow_disk_use;
    bsoncxx::v_noabi::stdx::optional<bool> _allow_partial_results;
    bsoncxx::v_noabi::stdx::optional<std::int32_t> _batch_size;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> _comment;
    bsoncxx::v_noabi::stdx::optional<cursor::type> _cursor_type;
    bsoncxx::v_noabi::stdx::optional<v_noabi::hint> _hint;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment_option;
    bsoncxx::v_noabi::stdx::optional<std::int64_t> _limit;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _max;
    bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_await_time;
    bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _min;
    bsoncxx::v_noabi::stdx::optional<bool> _no_cursor_timeout;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _projection;
    bsoncxx::v_noabi::stdx::optional<v_noabi::read_preference> _read_preference;
    bsoncxx::v_noabi::stdx::optional<bool> _return_key;
    bsoncxx::v_noabi::stdx::optional<bool> _show_record_id;
    bsoncxx::v_noabi::stdx::optional<std::int64_t> _skip;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _ordering;
};
 
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
 
namespace mongocxx {
namespace v_noabi {

inline v_noabi::options::find from_v1(v1::find_options v) {
    return {std::move(v)};
}

inline v1::find_options to_v1(v_noabi::options::find const& v) {
    return v1::find_options{v};
}
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>