encrypt.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/client_encryption-fwd.hpp>
#include <mongocxx/options/encrypt-fwd.hpp>
 
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/types.hpp>
#include <bsoncxx/types/bson_value/view_or_value.hpp>
 
#include <mongocxx/options/range.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace options {
 
class encrypt {
   public:
    MONGOCXX_ABI_EXPORT_CDECL(encrypt&)
    key_id(bsoncxx::v_noabi::types::bson_value::view_or_value key_id);
 
    MONGOCXX_ABI_EXPORT_CDECL(
        const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>&)
    key_id() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(encrypt&) key_alt_name(std::string name);
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<std::string>&)
    key_alt_name() const;
 
    enum class encryption_algorithm : std::uint8_t {
        k_deterministic,
 
        k_random,
 
        k_indexed,
 
        k_unindexed,
 
        k_range,
    };
 
    enum class encryption_query_type : std::uint8_t {
        k_equality,
 
        k_range,
    };
 
    MONGOCXX_ABI_EXPORT_CDECL(encrypt&) algorithm(encryption_algorithm algorithm);
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<encryption_algorithm>&)
    algorithm() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(encrypt&) contention_factor(int64_t contention_factor);
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<int64_t>&)
    contention_factor() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(encrypt&) query_type(encryption_query_type query_type);
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<encryption_query_type>&)
    query_type() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(encrypt&) range_opts(options::range opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<options::range>&)
    range_opts() const;
 
   private:
    friend ::mongocxx::v_noabi::client_encryption;
 
    void* convert() const;
 
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _key_id;
    bsoncxx::v_noabi::stdx::optional<std::string> _key_alt_name;
    bsoncxx::v_noabi::stdx::optional<encryption_algorithm> _algorithm;
    bsoncxx::v_noabi::stdx::optional<int64_t> _contention_factor;
    bsoncxx::v_noabi::stdx::optional<encryption_query_type> _query_type;
    bsoncxx::v_noabi::stdx::optional<options::range> _range_opts;
};
 
}  // namespace options
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>