server_api.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/server_api-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <string>
#include <system_error>
#include <type_traits>
 
namespace mongocxx {
namespace v1 {

class server_api {
    // This class implements `ServerApi`:
    //  - https://specifications.readthedocs.io/en/latest/versioned-api/versioned-api/
 
   private:
    class impl;
    void* _impl;
 
   public:
    enum class version {
        k_version_1,
    };

    MONGOCXX_ABI_EXPORT_CDECL() ~server_api();

    MONGOCXX_ABI_EXPORT_CDECL() server_api(server_api&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() server_api(server_api const& other);

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

    explicit MONGOCXX_ABI_EXPORT_CDECL() server_api(version v);

    static MONGOCXX_ABI_EXPORT_CDECL(std::string) version_to_string(version v);

    static MONGOCXX_ABI_EXPORT_CDECL(version) version_from_string(bsoncxx::v1::stdx::string_view v);

    MONGOCXX_ABI_EXPORT_CDECL(server_api&) strict(bool strict);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) strict() const;

    MONGOCXX_ABI_EXPORT_CDECL(server_api&) deprecation_errors(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) deprecation_errors() const;

    MONGOCXX_ABI_EXPORT_CDECL(version) get_version() const;

    enum class errc {
        zero,            
        invalid_version, 
    };

    static MONGOCXX_ABI_EXPORT_CDECL(std::error_category const&) error_category();

    friend std::error_code make_error_code(errc v) {
        return {static_cast<int>(v), error_category()};
    }
 
    class internal;
};
 
} // namespace v1
} // namespace mongocxx
 
namespace std {
 
template <>
struct is_error_code_enum<mongocxx::v1::server_api::errc> : true_type {};
 
} // namespace std
 
#include <mongocxx/v1/detail/postlude.hpp>