zarrs.h

Go to the documentation of this file.

#pragma once
 
/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
 
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
 
#undef NDEBUG
#ifdef __cplusplus
#include <cassert>
#else // __cplusplus
#include <assert.h>
#endif // __cplusplus
 
#define zarrs_assert(expr) assert(ZARRS_SUCCESS == expr)
 
 
enum ZarrsDataType
#ifdef __cplusplus
  : int32_t
#endif // __cplusplus
 {
  ZARRS_UNDEFINED = -1,
  ZARRS_BOOL = 0,
  ZARRS_INT8 = 1,
  ZARRS_INT16 = 2,
  ZARRS_INT32 = 3,
  ZARRS_INT64 = 4,
  ZARRS_UINT8 = 5,
  ZARRS_UINT16 = 6,
  ZARRS_UINT32 = 7,
  ZARRS_UINT64 = 8,
  ZARRS_FLOAT16 = 9,
  ZARRS_FLOAT32 = 10,
  ZARRS_FLOAT64 = 11,
  ZARRS_COMPLEX64 = 12,
  ZARRS_COMPLEX128 = 13,
  ZARRS_RAW_BITS = 14,
  ZARRS_BFLOAT16 = 15,
};
#ifndef __cplusplus
typedef int32_t ZarrsDataType;
#endif // __cplusplus
 
enum ZarrsResult
#ifdef __cplusplus
  : int32_t
#endif // __cplusplus
 {
  ZARRS_SUCCESS = 0,
  ZARRS_ERROR_NULL_PTR = -1,
  ZARRS_ERROR_STORAGE = -2,
  ZARRS_ERROR_ARRAY = -3,
  ZARRS_ERROR_BUFFER_LENGTH = -4,
  ZARRS_ERROR_INVALID_INDICES = -5,
  ZARRS_ERROR_NODE_PATH = -6,
  ZARRS_ERROR_STORE_PREFIX = -7,
  ZARRS_ERROR_INVALID_METADATA = -8,
  ZARRS_ERROR_STORAGE_CAPABILITY = -9,
  ZARRS_ERROR_UNKNOWN_CHUNK_GRID_SHAPE = -10,
  ZARRS_ERROR_UNKNOWN_INTERSECTING_CHUNKS = -11,
  ZARRS_ERROR_UNSUPPORTED_DATA_TYPE = -12,
  ZARRS_ERROR_GROUP = -13,
  ZARRS_ERROR_INCOMPATIBLE_DIMENSIONALITY = -14,
};
#ifndef __cplusplus
typedef int32_t ZarrsResult;
#endif // __cplusplus
 
typedef struct ZarrsArray_T ZarrsArray_T;
 
typedef struct ZarrsGroup_T ZarrsGroup_T;
 
typedef struct ZarrsShardIndexCache_T ZarrsShardIndexCache_T;
 
typedef struct ZarrsStorage_T ZarrsStorage_T;
 
typedef struct ZarrsArray_T *ZarrsArray;
 
typedef struct ZarrsShardIndexCache_T *ZarrsShardIndexCache;
 
typedef struct ZarrsStorage_T *ZarrsStorage;
 
typedef struct ZarrsGroup_T *ZarrsGroup;
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
ZarrsResult zarrsArrayGetAttributes(ZarrsArray array, bool pretty, char **pAttributesString);
 
ZarrsResult zarrsArrayGetAttributesString(ZarrsArray array, bool pretty, char **pAttributesString);
 
ZarrsResult zarrsArrayGetChunkGridShape(ZarrsArray array,
                                        size_t dimensionality,
                                        uint64_t *pChunkGridShape);
 
ZarrsResult zarrsArrayGetChunkOrigin(ZarrsArray array,
                                     size_t dimensionality,
                                     const uint64_t *pChunkIndices,
                                     uint64_t *pChunkOrigin);
 
ZarrsResult zarrsArrayGetChunkShape(ZarrsArray array,
                                    size_t dimensionality,
                                    const uint64_t *pChunkIndices,
                                    uint64_t *pChunkShape);
 
ZarrsResult zarrsArrayGetChunkSize(ZarrsArray array,
                                   size_t dimensionality,
                                   const uint64_t *pChunkIndices,
                                   size_t *chunkSize);
 
ZarrsResult zarrsArrayGetChunksInSubset(ZarrsArray array,
                                        size_t dimensionality,
                                        const uint64_t *pSubsetStart,
                                        const uint64_t *pSubsetShape,
                                        uint64_t *pChunksStart,
                                        uint64_t *pChunksShape);
 
ZarrsResult zarrsArrayGetDataType(ZarrsArray array, ZarrsDataType *pDataType);
 
ZarrsResult zarrsArrayGetDimensionality(ZarrsArray array, size_t *dimensionality);
 
ZarrsResult zarrsArrayGetInnerChunkGridShape(ZarrsArray array,
                                             size_t dimensionality,
                                             uint64_t *pInnerChunkGridShape);
 
ZarrsResult zarrsArrayGetInnerChunkShape(ZarrsArray array,
                                         size_t dimensionality,
                                         bool *pIsSharded,
                                         uint64_t *pInnerChunkShape);
 
ZarrsResult zarrsArrayGetMetadataString(ZarrsArray array, bool pretty, char **pMetadataString);
 
ZarrsResult zarrsArrayGetShape(ZarrsArray array,
                               size_t dimensionality,
                               uint64_t *pShape);
 
ZarrsResult zarrsArrayGetSubsetSize(ZarrsArray array,
                                    size_t dimensionality,
                                    const uint64_t *pSubsetShape,
                                    size_t *subsetSize);
 
ZarrsResult zarrsArrayRetrieveChunk(ZarrsArray array,
                                    size_t dimensionality,
                                    const uint64_t *pChunkIndices,
                                    size_t chunkBytesCount,
                                    uint8_t *pChunkBytes);
 
ZarrsResult zarrsArrayRetrieveInnerChunk(ZarrsArray array,
                                         ZarrsShardIndexCache cache,
                                         size_t dimensionality,
                                         const uint64_t *pChunkIndices,
                                         size_t chunkBytesCount,
                                         uint8_t *pChunkBytes);
 
ZarrsResult zarrsArrayRetrieveSubset(ZarrsArray array,
                                     size_t dimensionality,
                                     const uint64_t *pSubsetStart,
                                     const uint64_t *pSubsetShape,
                                     size_t subsetBytesCount,
                                     uint8_t *pSubsetBytes);
 
ZarrsResult zarrsArrayRetrieveSubsetSharded(ZarrsArray array,
                                            ZarrsShardIndexCache cache,
                                            size_t dimensionality,
                                            const uint64_t *pSubsetStart,
                                            const uint64_t *pSubsetShape,
                                            size_t subsetBytesCount,
                                            uint8_t *pSubsetBytes);
 
ZarrsResult zarrsArraySetAttributes(ZarrsArray array,
                                    const char* attributes);
 
ZarrsResult zarrsArrayStoreChunk(ZarrsArray array,
                                 size_t dimensionality,
                                 const uint64_t *pChunkIndices,
                                 size_t chunkBytesCount,
                                 const uint8_t *pChunkBytes);
 
ZarrsResult zarrsArrayStoreMetadata(ZarrsArray array);
 
ZarrsResult zarrsArrayStoreSubset(ZarrsArray array,
                                  size_t dimensionality,
                                  const uint64_t *pSubsetStart,
                                  const uint64_t *pSubsetShape,
                                  size_t subsetBytesCount,
                                  const uint8_t *pSubsetBytes);
 
ZarrsResult zarrsCreateArrayRW(ZarrsStorage storage,
                               const char* path,
                               const char* metadata,
                               ZarrsArray *pArray);
 
ZarrsResult zarrsCreateGroupRW(ZarrsStorage storage,
                               const char* path,
                               const char* metadata,
                               ZarrsGroup *pGroup);
 
ZarrsResult zarrsCreateShardIndexCache(ZarrsArray array, ZarrsShardIndexCache *pShardIndexCache);
 
ZarrsResult zarrsCreateStorageFilesystem(const char* path, ZarrsStorage *pStorage);
 
ZarrsResult zarrsDestroyArray(ZarrsArray array);
 
ZarrsResult zarrsDestroyGroup(ZarrsGroup group);
 
ZarrsResult zarrsDestroyShardIndexCache(ZarrsShardIndexCache shardIndexCache);
 
ZarrsResult zarrsDestroyStorage(ZarrsStorage storage);
 
ZarrsResult zarrsFreeString(char *string);
 
ZarrsResult zarrsGroupGetAttributes(ZarrsGroup group, bool pretty, char **pAttributesString);
 
ZarrsResult zarrsGroupSetAttributes(ZarrsGroup group,
                                    const char* attributes);
 
ZarrsResult zarrsGroupStoreMetadata(ZarrsGroup group);
 
char *zarrsLastError(void);
 
ZarrsResult zarrsOpenArrayRW(ZarrsStorage storage, const char* path, ZarrsArray *pArray);
 
ZarrsResult zarrsOpenGroupRW(ZarrsStorage storage, const char* path, ZarrsGroup *pGroup);
 
uint32_t zarrsVersion(void);
 
uint32_t zarrsVersionMajor(void);
 
uint32_t zarrsVersionMinor(void);
 
uint32_t zarrsVersionPatch(void);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus