encrypt.hpp

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