c4BlobStore.h

Go to the documentation of this file.

//
// c4BlobStore.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 "c4BlobStoreTypes.h"
#include "c4DatabaseTypes.h"
#ifdef __cplusplus
#    include <cstdio>
#else
#    include <stdio.h>
#endif
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
CBL_CORE_API bool c4blob_keyFromString(C4String str, C4BlobKey*) C4API;
 
CBL_CORE_API C4StringResult c4blob_keyToString(C4BlobKey) C4API;
 
 
CBL_CORE_API C4BlobStore* c4db_getBlobStore(C4Database* db, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API C4BlobStore* c4blob_openStore(C4String dirPath, C4DatabaseFlags flags,
                                                     const C4EncryptionKey* C4NULLABLE encryptionKey,
                                                     C4Error* C4NULLABLE               outError) C4API;
 
CBL_CORE_API void c4blob_freeStore(C4BlobStore* C4NULLABLE) C4API;
 
CBL_CORE_API bool c4blob_deleteStore(C4BlobStore*, C4Error* C4NULLABLE) C4API;
 
/* NOTE: Every function in this section is thread-safe, as long as the C4BlobStore
       reference remains valid while the function executes, i.e. there are no concurrent calls
       to c4blob_freeStore, c4blob_deleteStore or c4db_close. */
 
CBL_CORE_API int64_t c4blob_getSize(C4BlobStore*, C4BlobKey) C4API;
 
CBL_CORE_API C4SliceResult c4blob_getContents(C4BlobStore*, C4BlobKey, C4Error* C4NULLABLE) C4API;
 
CBL_CORE_API C4StringResult c4blob_getFilePath(C4BlobStore*, C4BlobKey, C4Error* C4NULLABLE) C4API;
 
NODISCARD CBL_CORE_API C4BlobKey c4blob_computeKey(C4Slice contents);
 
NODISCARD CBL_CORE_API bool c4blob_create(C4BlobStore* store, C4Slice contents, const C4BlobKey* C4NULLABLE expectedKey,
                                          C4BlobKey* C4NULLABLE outKey, C4Error* C4NULLABLE error) C4API;
 
NODISCARD CBL_CORE_API bool c4blob_delete(C4BlobStore*, C4BlobKey, C4Error* C4NULLABLE) C4API;
 
 
NODISCARD CBL_CORE_API C4ReadStream* c4blob_openReadStream(C4BlobStore*, C4BlobKey, C4Error* C4NULLABLE) C4API;
 
NODISCARD CBL_CORE_API size_t c4stream_read(C4ReadStream* stream, void* buffer, size_t maxBytesToRead,
                                            C4Error* C4NULLABLE error) C4API;
 
CBL_CORE_API int64_t c4stream_getLength(C4ReadStream*, C4Error* C4NULLABLE) C4API;
 
NODISCARD CBL_CORE_API bool c4stream_seek(C4ReadStream*, uint64_t position, C4Error* C4NULLABLE) C4API;
 
NODISCARD CBL_CORE_API C4WriteStream* c4blob_openWriteStream(C4BlobStore*, C4Error* C4NULLABLE) C4API;
 
NODISCARD CBL_CORE_API bool c4stream_write(C4WriteStream*, const void* bytes, size_t length, C4Error* C4NULLABLE) C4API;
 
CBL_CORE_API uint64_t c4stream_bytesWritten(C4WriteStream*) C4API;
 
NODISCARD CBL_CORE_API C4BlobKey c4stream_computeBlobKey(C4WriteStream*) C4API;
 
NODISCARD CBL_CORE_API bool c4stream_install(C4WriteStream*, const C4BlobKey* C4NULLABLE expectedKey,
                                             C4Error* C4NULLABLE) C4API;
 
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END