c4Document+Fleece.h

Go to the documentation of this file.

//
// c4Document+Fleece.h
//
// Copyright 2016-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
 
#include "c4Document.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
#define kC4ObjectTypeProperty "@type"
 
 
#define kC4ObjectType_Blob "blob"
 
#define kC4BlobDigestProperty "digest"
 
#define kC4BlobDataProperty "data"
 
#define kC4LegacyAttachmentsProperty "_attachments"
 
 
#define kC4ObjectType_Encryptable "encryptable"
 
#define kC4EncryptableValueProperty "value"
 
 
CBL_CORE_API FLDict c4doc_getProperties(C4Document* C4NONNULL) C4API;
 
NODISCARD CBL_CORE_API FLDoc c4doc_createFleeceDoc(C4Document*);
 
NODISCARD CBL_CORE_API bool c4doc_resolveConflict2(C4Document* doc, C4String winningRevID, C4String losingRevID,
                                                   FLDict C4NULLABLE mergedProperties, C4RevisionFlags mergedFlags,
                                                   C4Error* C4NULLABLE error) C4API;
 
CBL_CORE_API C4Document* c4doc_containingValue(FLValue value);
 
CBL_CORE_API bool c4doc_isOldMetaProperty(C4String prop) C4API;
 
CBL_CORE_API bool c4doc_hasOldMetaProperties(FLDict doc) C4API;
 
CBL_CORE_API C4SliceResult c4doc_encodeStrippingOldMetaProperties(FLDict doc, FLSharedKeys sk,
                                                                  C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4doc_getDictBlobKey(FLDict dict, C4BlobKey* outKey);
 
NODISCARD CBL_CORE_API bool c4doc_dictIsBlob(FLDict dict, C4BlobKey* outKey) C4API;
 
CBL_CORE_API bool c4doc_dictContainsBlobs(FLDict dict) C4API;
 
CBL_CORE_API C4SliceResult c4doc_getBlobData(FLDict dict, C4BlobStore* C4NULLABLE blobStore,
                                             C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API bool c4doc_blobIsCompressible(FLDict blobDict);
 
CBL_CORE_API C4StringResult c4doc_bodyAsJSON(C4Document* doc, bool canonical, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API FLEncoder c4db_createFleeceEncoder(C4Database* db) C4API;
 
CBL_CORE_API FLEncoder c4db_getSharedFleeceEncoder(C4Database* db) C4API;
 
CBL_CORE_API C4SliceResult c4db_encodeJSON(C4Database*, C4String jsonData, C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API FLSharedKeys c4db_getFLSharedKeys(C4Database* db) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END