CBLEncryptable.h

Go to the documentation of this file.

//
// CBLEncryptable.h
//
// Copyright (c) 2021 Couchbase, Inc All rights reserved.
//
// 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 "CBLBase.h"
 
#ifdef COUCHBASE_ENTERPRISE
 
CBL_CAPI_BEGIN
 
CBL_PUBLIC extern const FLSlice kCBLEncryptableType;                
CBL_PUBLIC extern const FLSlice kCBLEncryptableValueProperty;       
 
CBL_REFCOUNTED(CBLEncryptable*, Encryptable);
 
#ifdef __APPLE__
#pragma mark - CREATING:
#endif
 
CBLEncryptable* CBLEncryptable_CreateWithNull(void) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithBool(bool value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithInt(int64_t value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithUInt(uint64_t value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithFloat(float value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithDouble(double value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithString(FLString value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithValue(FLValue value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithArray(FLArray value) CBLAPI;
 
CBLEncryptable* CBLEncryptable_CreateWithDict(FLDict value) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - READING:
#endif
 
FLValue CBLEncryptable_Value(const CBLEncryptable* encryptable) CBLAPI;
 
FLDict CBLEncryptable_Properties(const CBLEncryptable* encryptable) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - FLEECE:
#endif
 
bool FLDict_IsEncryptableValue(FLDict _cbl_nullable) CBLAPI;
 
static inline bool FLValue_IsEncryptableValue(FLValue _cbl_nullable value) {
    return FLDict_IsEncryptableValue(FLValue_AsDict(value));
}
 
const CBLEncryptable* _cbl_nullable FLDict_GetEncryptableValue(FLDict _cbl_nullable encryptableDict) CBLAPI;
 
static inline const CBLEncryptable* _cbl_nullable FLValue_GetEncryptableValue(FLValue _cbl_nullable value) {
    return FLDict_GetEncryptableValue(FLValue_AsDict(value));
}
 
void FLSlot_SetEncryptableValue(FLSlot slot, const CBLEncryptable* encryptable) CBLAPI;
 
static inline void FLMutableDict_SetEncryptableValue(FLMutableDict dict, FLString key, CBLEncryptable* encryptable) {
    FLSlot_SetEncryptableValue(FLMutableDict_Set(dict, key), encryptable);
}
 
CBL_CAPI_END
 
#endif