CBLBlob.h

Go to the documentation of this file.

//
// CBLBlob.h
//
// Copyright (c) 2018 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"
#include "fleece/Fleece.h"
 
CBL_CAPI_BEGIN
 
    CBL_PUBLIC extern const FLSlice kCBLBlobType;                 
    CBL_PUBLIC extern const FLSlice kCBLBlobDigestProperty;       
    CBL_PUBLIC extern const FLSlice kCBLBlobLengthProperty;       
    CBL_PUBLIC extern const FLSlice kCBLBlobContentTypeProperty;  
 
 
    CBL_REFCOUNTED(CBLBlob*, Blob);
 
 
    bool FLDict_IsBlob(FLDict _cbl_nullable) CBLAPI;
 
    const CBLBlob* _cbl_nullable FLDict_GetBlob(FLDict _cbl_nullable blobDict) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - BLOB METADATA:
#endif
 
    uint64_t CBLBlob_Length(const CBLBlob*) CBLAPI;
 
    FLString CBLBlob_Digest(const CBLBlob*) CBLAPI;
 
    FLString CBLBlob_ContentType(const CBLBlob*) CBLAPI;
 
    FLDict CBLBlob_Properties(const CBLBlob*) CBLAPI;
 
    _cbl_warn_unused
    FLStringResult CBLBlob_CreateJSON(const CBLBlob* blob) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - READING:
#endif
 
    _cbl_warn_unused
    FLSliceResult CBLBlob_Content(const CBLBlob* blob,
                                  CBLError* _cbl_nullable outError) CBLAPI;
 
    typedef struct CBLBlobReadStream CBLBlobReadStream;
 
    _cbl_warn_unused
    CBLBlobReadStream* _cbl_nullable CBLBlob_OpenContentStream(const CBLBlob* blob,
                                                               CBLError* _cbl_nullable) CBLAPI;
 
    int CBLBlobReader_Read(CBLBlobReadStream* stream,
                           void *dst,
                           size_t maxLength,
                           CBLError* _cbl_nullable outError) CBLAPI;
 
    typedef CBL_ENUM(uint8_t, CBLSeekBase) {
        kCBLSeekModeFromStart,  
        kCBLSeekModeRelative,   
        kCBLSeekModeFromEnd     
    };
 
    int64_t CBLBlobReader_Seek(CBLBlobReadStream* stream,
                               int64_t offset,
                               CBLSeekBase base,
                               CBLError* _cbl_nullable outError) CBLAPI;
 
    uint64_t CBLBlobReader_Position(CBLBlobReadStream* stream) CBLAPI;
 
    void CBLBlobReader_Close(CBLBlobReadStream* _cbl_nullable) CBLAPI;
 
    bool CBLBlob_Equals(CBLBlob* blob, CBLBlob* anotherBlob) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - CREATING:
#endif
 
    _cbl_warn_unused
    CBLBlob* CBLBlob_CreateWithData(FLString contentType, FLSlice contents) CBLAPI;
 
    typedef struct CBLBlobWriteStream CBLBlobWriteStream;
 
    _cbl_warn_unused
    CBLBlobWriteStream* _cbl_nullable CBLBlobWriter_Create(CBLDatabase* db,
                                                           CBLError* _cbl_nullable) CBLAPI;
 
    void CBLBlobWriter_Close(CBLBlobWriteStream* _cbl_nullable) CBLAPI;
 
    bool CBLBlobWriter_Write(CBLBlobWriteStream* writer,
                             const void *data,
                             size_t length,
                             CBLError* _cbl_nullable outError) CBLAPI;
 
    _cbl_warn_unused
    CBLBlob* CBLBlob_CreateWithStream(FLString contentType,
                                      CBLBlobWriteStream* writer) CBLAPI;
 
#ifdef __APPLE__
#pragma mark - FLEECE UTILITIES:
#endif
 
    static inline bool FLValue_IsBlob(FLValue _cbl_nullable v) {
        return FLDict_IsBlob(FLValue_AsDict(v));
    }
 
    static inline const CBLBlob* _cbl_nullable FLValue_GetBlob(FLValue _cbl_nullable value) {
        return FLDict_GetBlob(FLValue_AsDict(value));
    }
 
    void FLSlot_SetBlob(FLSlot slot, CBLBlob* blob) CBLAPI;
 
    static inline void FLMutableArray_SetBlob(FLMutableArray array, uint32_t index, CBLBlob *blob) {
        FLSlot_SetBlob(FLMutableArray_Set(array, index), blob);
    }
 
    static inline void FLMutableArray_AppendBlob(FLMutableArray array, CBLBlob *blob) {
        FLSlot_SetBlob(FLMutableArray_Append(array), blob);
    }
 
    static inline void FLMutableDict_SetBlob(FLMutableDict dict, FLString key, CBLBlob *blob) {
        FLSlot_SetBlob(FLMutableDict_Set(dict, key), blob);
    }
 
 
#ifdef __APPLE__
#pragma mark - BINDING DEV SUPPORT FOR BLOB:
#endif
 
    const CBLBlob* _cbl_nullable CBLDatabase_GetBlob(CBLDatabase* db, FLDict properties,
                                                     CBLError* _cbl_nullable outError) CBLAPI;
 
    bool CBLDatabase_SaveBlob(CBLDatabase* db, CBLBlob* blob,
                              CBLError* _cbl_nullable outError) CBLAPI;
 
CBL_CAPI_END