hint.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 <string>
 
#include <mongocxx/hint-fwd.hpp>
 
#include <bsoncxx/document/value.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/view.hpp>
 
#include <mongocxx/stdx.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class hint {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() hint(bsoncxx::v_noabi::document::view_or_value index);
 
    explicit MONGOCXX_ABI_EXPORT_CDECL() hint(bsoncxx::v_noabi::string::view_or_value index);
 
    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(const hint& index_hint, std::string index);
 
    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(const hint& index_hint,
                                                      bsoncxx::v_noabi::document::view index);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::types::bson_value::view) to_value() const;
 
    operator bsoncxx::v_noabi::types::bson_value::view() const {
        return to_value();
    }
 
   private:
    stdx::optional<bsoncxx::v_noabi::document::view_or_value> _index_doc;
    stdx::optional<bsoncxx::v_noabi::string::view_or_value> _index_string;
};
 
 
MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(std::string index, const hint& index_hint);
 
MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(const hint& index_hint, std::string index);
 
MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(std::string index, const hint& index_index);
 
 
 
MONGOCXX_ABI_EXPORT_CDECL(bool)
operator==(bsoncxx::v_noabi::document::view index, const hint& index_hint);
MONGOCXX_ABI_EXPORT_CDECL(bool)
operator!=(const hint& index_hint, bsoncxx::v_noabi::document::view index);
MONGOCXX_ABI_EXPORT_CDECL(bool)
operator!=(bsoncxx::v_noabi::document::view index, const hint& index_hint);
 
 
}  // namespace v_noabi
}  // namespace mongocxx
 
namespace mongocxx {
 
using ::mongocxx::v_noabi::operator==;
using ::mongocxx::v_noabi::operator!=;
 
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>
 
 
#if defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
 
namespace mongocxx {
 
bool operator==(std::string index, const v_noabi::hint& index_hint);
 
bool operator!=(const v_noabi::hint& index_hint, std::string index);
 
bool operator!=(std::string index, const v_noabi::hint& index_index);
 
bool operator==(bsoncxx::v_noabi::document::view index, const v_noabi::hint& index_hint);
 
bool operator!=(const v_noabi::hint& index_hint, bsoncxx::v_noabi::document::view index);
 
bool operator!=(bsoncxx::v_noabi::document::view index, const v_noabi::hint& index_hint);
 
}  // namespace mongocxx
 
#endif  // defined(MONGOCXX_PRIVATE_DOXYGEN_PREPROCESSOR)