zarrs_ffi
C/C++ bindings for the zarrs rust crate
Macros | Typedefs | Enumerations | Functions
zarrs.h File Reference
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdlib.h>
#include <assert.h>
Include dependency graph for zarrs.h:

Go to the source code of this file.

Macros

#define zarrs_assert(expr)   assert(ZARRS_SUCCESS == expr)
 

Typedefs

typedef int32_t ZarrsDataType
 
typedef int32_t ZarrsResult
 
typedef struct ZarrsArray_T ZarrsArray_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
 

Enumerations

enum  ZarrsDataType {
  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
}
 
enum  ZarrsResult {
  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
}
 

Functions

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 zarrsCreateShardIndexCache (ZarrsArray array, ZarrsShardIndexCache *pShardIndexCache)
 
ZarrsResult zarrsCreateStorageFilesystem (const char *path, ZarrsStorage *pStorage)
 
ZarrsResult zarrsDestroyArray (ZarrsArray array)
 
ZarrsResult zarrsDestroyShardIndexCache (ZarrsShardIndexCache shardIndexCache)
 
ZarrsResult zarrsDestroyStorage (ZarrsStorage storage)
 
ZarrsResult zarrsFreeString (char *string)
 
char * zarrsLastError (void)
 
ZarrsResult zarrsOpenArrayRW (ZarrsStorage storage, const char *path, ZarrsArray *pArray)
 
uint32_t zarrsVersion (void)
 
uint32_t zarrsVersionMajor (void)
 
uint32_t zarrsVersionMinor (void)
 
uint32_t zarrsVersionPatch (void)
 

Macro Definition Documentation

◆ zarrs_assert

#define zarrs_assert (   expr)    assert(ZARRS_SUCCESS == expr)

Definition at line 18 of file zarrs.h.

Typedef Documentation

◆ ZarrsArray

typedef struct ZarrsArray_T* ZarrsArray

An opaque handle to a zarr array.

Definition at line 83 of file zarrs.h.

◆ ZarrsArray_T

typedef struct ZarrsArray_T ZarrsArray_T

Definition at line 71 of file zarrs.h.

◆ ZarrsDataType

typedef int32_t ZarrsDataType

Definition at line 48 of file zarrs.h.

◆ ZarrsResult

typedef int32_t ZarrsResult

Definition at line 71 of file zarrs.h.

◆ ZarrsShardIndexCache

typedef struct ZarrsShardIndexCache_T* ZarrsShardIndexCache

An opaque handle to a zarrs [ArrayShardedReadableExtCache].

Definition at line 88 of file zarrs.h.

◆ ZarrsShardIndexCache_T

typedef struct ZarrsShardIndexCache_T ZarrsShardIndexCache_T

Definition at line 71 of file zarrs.h.

◆ ZarrsStorage

typedef struct ZarrsStorage_T* ZarrsStorage

An opaque handle to a zarr store or storage transformer.

Definition at line 93 of file zarrs.h.

◆ ZarrsStorage_T

typedef struct ZarrsStorage_T ZarrsStorage_T

Definition at line 71 of file zarrs.h.

Enumeration Type Documentation

◆ ZarrsDataType

enum ZarrsDataType

A zarrs data type.

Enumerator
ZARRS_UNDEFINED 
ZARRS_BOOL 
ZARRS_INT8 
ZARRS_INT16 
ZARRS_INT32 
ZARRS_INT64 
ZARRS_UINT8 
ZARRS_UINT16 
ZARRS_UINT32 
ZARRS_UINT64 
ZARRS_FLOAT16 
ZARRS_FLOAT32 
ZARRS_FLOAT64 
ZARRS_COMPLEX64 
ZARRS_COMPLEX128 
ZARRS_RAW_BITS 
ZARRS_BFLOAT16 

Definition at line 24 of file zarrs.h.

◆ ZarrsResult

enum ZarrsResult
Enumerator
ZARRS_SUCCESS 
ZARRS_ERROR_NULL_PTR 
ZARRS_ERROR_STORAGE 
ZARRS_ERROR_ARRAY 
ZARRS_ERROR_BUFFER_LENGTH 
ZARRS_ERROR_INVALID_INDICES 
ZARRS_ERROR_NODE_PATH 
ZARRS_ERROR_STORE_PREFIX 
ZARRS_ERROR_INVALID_METADATA 
ZARRS_ERROR_STORAGE_CAPABILITY 
ZARRS_ERROR_UNKNOWN_CHUNK_GRID_SHAPE 
ZARRS_ERROR_UNKNOWN_INTERSECTING_CHUNKS 
ZARRS_ERROR_UNSUPPORTED_DATA_TYPE 

Definition at line 51 of file zarrs.h.

Function Documentation

◆ zarrsArrayGetAttributesString()

ZarrsResult zarrsArrayGetAttributesString ( ZarrsArray  array,
bool  pretty,
char **  pAttributesString 
)

Get the array attributes as a JSON string.

The string must be freed with zarrsFreeString.

Safety

array must be a valid ZarrsArray handle.

◆ zarrsArrayGetChunkGridShape()

ZarrsResult zarrsArrayGetChunkGridShape ( ZarrsArray  array,
size_t  dimensionality,
uint64_t *  pChunkGridShape 
)

Return the number of chunks in the chunk grid.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if array is a null pointer. Returns ZarrsResult::ZARRS_ERROR_UNKNOWN_CHUNK_GRID_SHAPE if the chunk grid shape cannot be determined.

Safety

If not null, array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkGridShape.

◆ zarrsArrayGetChunkOrigin()

ZarrsResult zarrsArrayGetChunkOrigin ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pChunkIndices,
uint64_t *  pChunkOrigin 
)

Get the origin of a chunk.

pChunkIndices is a pointer to an array of length dimensionality holding the chunk indices.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkIndices and pChunkOrigin.

◆ zarrsArrayGetChunkShape()

ZarrsResult zarrsArrayGetChunkShape ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pChunkIndices,
uint64_t *  pChunkShape 
)

Get the shape of a chunk.

pChunkIndices is a pointer to an array of length dimensionality holding the chunk indices.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkIndices and pChunkShape.

◆ zarrsArrayGetChunksInSubset()

ZarrsResult zarrsArrayGetChunksInSubset ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pSubsetStart,
const uint64_t *  pSubsetShape,
uint64_t *  pChunksStart,
uint64_t *  pChunksShape 
)

Return the chunks indicating the chunks intersecting array_subset.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if array is a null pointer. Returns ZarrsResult::ZARRS_ERROR_UNKNOWN_INTERSECTING_CHUNKS if the intersecting chunks cannot be determined.

Safety

If not null, array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the arrays pointed to by pSubsetStart, pSubsetShape, pChunksStart, and pChunksShape.

◆ zarrsArrayGetChunkSize()

ZarrsResult zarrsArrayGetChunkSize ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pChunkIndices,
size_t *  chunkSize 
)

Get the size of a chunk in bytes.

pChunkIndices is a pointer to an array of length dimensionality holding the chunk indices.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkIndices.

◆ zarrsArrayGetDataType()

ZarrsResult zarrsArrayGetDataType ( ZarrsArray  array,
ZarrsDataType *  pDataType 
)

Returns the data type of the array.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if array is a null pointer.

Safety

If not null, array must be a valid ZarrsArray handle.

◆ zarrsArrayGetDimensionality()

ZarrsResult zarrsArrayGetDimensionality ( ZarrsArray  array,
size_t *  dimensionality 
)

Returns the dimensionality of the array.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if array is a null pointer.

Safety

If not null, array must be a valid ZarrsArray handle.

◆ zarrsArrayGetInnerChunkGridShape()

ZarrsResult zarrsArrayGetInnerChunkGridShape ( ZarrsArray  array,
size_t  dimensionality,
uint64_t *  pInnerChunkGridShape 
)

Get the shape of the inner chunk grid of a sharded array.

If the array is not sharded, the contents of pInnerChunkGridShape will equal the standard chunk grid shape.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pInnerChunkGridShape.

◆ zarrsArrayGetInnerChunkShape()

ZarrsResult zarrsArrayGetInnerChunkShape ( ZarrsArray  array,
size_t  dimensionality,
bool *  pIsSharded,
uint64_t *  pInnerChunkShape 
)

Get the inner chunk shape for a sharded array.

pIsSharded is set to true if the array is sharded, otherwise false. If the array is not sharded, the contents of pInnerChunkShape will be undefined.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkShape.

◆ zarrsArrayGetMetadataString()

ZarrsResult zarrsArrayGetMetadataString ( ZarrsArray  array,
bool  pretty,
char **  pMetadataString 
)

Get the array metadata as a JSON string.

The string must be freed with zarrsFreeString.

Safety

array must be a valid ZarrsArray handle.

◆ zarrsArrayGetShape()

ZarrsResult zarrsArrayGetShape ( ZarrsArray  array,
size_t  dimensionality,
uint64_t *  pShape 
)

Returns the shape of the array.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if array is a null pointer.

Safety

If not null, array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pShape.

◆ zarrsArrayGetSubsetSize()

ZarrsResult zarrsArrayGetSubsetSize ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pSubsetShape,
size_t *  subsetSize 
)

Get the size of a subset in bytes.

pSubsetShape is a pointer to an array of length dimensionality holding the shape of the subset.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pSubsetShape.

◆ zarrsArrayRetrieveChunk()

ZarrsResult zarrsArrayRetrieveChunk ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pChunkIndices,
size_t  chunkBytesCount,
uint8_t *  pChunkBytes 
)

Retrieve a chunk from an array.

pChunkIndices is a pointer to an array of length dimensionality holding the chunk indices. pChunkBytes is a pointer to an array of bytes of length chunkBytesCount that must match the expected size of the chunk as returned by zarrsArrayGetChunkSize().

Errors

Returns an error if the array does not have read capability.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkIndices.

◆ zarrsArrayRetrieveInnerChunk()

ZarrsResult zarrsArrayRetrieveInnerChunk ( ZarrsArray  array,
ZarrsShardIndexCache  cache,
size_t  dimensionality,
const uint64_t *  pChunkIndices,
size_t  chunkBytesCount,
uint8_t *  pChunkBytes 
)

Retrieve an inner chunk from a sharded array (or outer chunk for an unsharded array).

pChunkIndices is a pointer to an array of length dimensionality holding the chunk indices. pChunkBytes is a pointer to an array of bytes of length chunkBytesCount that must match the expected size of the chunk as returned by zarrsArrayGetChunkSize().

Errors

Returns an error if the array does not have read capability.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkIndices.

◆ zarrsArrayRetrieveSubset()

ZarrsResult zarrsArrayRetrieveSubset ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pSubsetStart,
const uint64_t *  pSubsetShape,
size_t  subsetBytesCount,
uint8_t *  pSubsetBytes 
)

Retrieve a subset from an array.

pSubsetStart and pSubsetShape are pointers to arrays of length dimensionality holding the chunk start and shape respectively. pSubsetBytes is a pointer to an array of bytes of length subsetBytesCount that must match the expected size of the subset as returned by zarrsArrayGetSubsetSize().

Errors

Returns an error if the array does not have read capability.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the arrays pointed to by pSubsetStart and pSubsetShape.

◆ zarrsArrayRetrieveSubsetSharded()

ZarrsResult zarrsArrayRetrieveSubsetSharded ( ZarrsArray  array,
ZarrsShardIndexCache  cache,
size_t  dimensionality,
const uint64_t *  pSubsetStart,
const uint64_t *  pSubsetShape,
size_t  subsetBytesCount,
uint8_t *  pSubsetBytes 
)

Retrieve a subset from an array (with a shard index cache).

pSubsetStart and pSubsetShape are pointers to arrays of length dimensionality holding the chunk start and shape respectively. pSubsetBytes is a pointer to an array of bytes of length subsetBytesCount that must match the expected size of the subset as returned by zarrsArrayGetSubsetSize().

Errors

Returns an error if the array does not have read capability.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the arrays pointed to by pSubsetStart and pSubsetShape.

◆ zarrsArraySetAttributes()

ZarrsResult zarrsArraySetAttributes ( ZarrsArray  array,
const char *  attributes 
)

Set the array attributes from a JSON string.

Errors

Returns ZarrsResult::ZARRS_ERROR_INVALID_METADATA if attributes is not a valid JSON object (map).

Safety

array must be a valid ZarrsArray handle.

◆ zarrsArrayStoreChunk()

ZarrsResult zarrsArrayStoreChunk ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pChunkIndices,
size_t  chunkBytesCount,
const uint8_t *  pChunkBytes 
)

Store a chunk.

pChunkIndices is a pointer to an array of length dimensionality holding the chunk indices. pChunkBytes is a pointer to an array of bytes of length chunkBytesCount that must match the expected size of the chunk as returned by zarrsArrayGetChunkSize().

Errors

Returns an error if the array does not have write capability.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the array pointed to by pChunkIndices.

◆ zarrsArrayStoreMetadata()

ZarrsResult zarrsArrayStoreMetadata ( ZarrsArray  array)

Store array metadata.

Errors

Returns an error if the array does not have write capability.

Safety

array must be a valid ZarrsArray handle.

◆ zarrsArrayStoreSubset()

ZarrsResult zarrsArrayStoreSubset ( ZarrsArray  array,
size_t  dimensionality,
const uint64_t *  pSubsetStart,
const uint64_t *  pSubsetShape,
size_t  subsetBytesCount,
const uint8_t *  pSubsetBytes 
)

Store an array subset.

pSubsetStart and pSubsetShape are pointers to arrays of length dimensionality holding the chunk start and shape respectively. pSubsetBytes is a pointer to an array of bytes of length subsetBytesCount that must match the expected size of the subset as returned by zarrsArrayGetSubsetSize().

Errors

Returns an error if the array does not have read/write capability.

Safety

array must be a valid ZarrsArray handle. dimensionality must match the dimensionality of the array and the length of the arrays pointed to by pSubsetStart and pSubsetShape.

◆ zarrsCreateArrayRW()

ZarrsResult zarrsCreateArrayRW ( ZarrsStorage  storage,
const char *  path,
const char *  metadata,
ZarrsArray *  pArray 
)

Create a handle to a new array (read/write capability).

metadata is expected to be a JSON string representing a zarr V3 array zarr.json. pArray is a pointer to a handle in which the created ZarrsArray is returned.

Safety

pArray must be a valid pointer to a ZarrsArray handle.

◆ zarrsCreateShardIndexCache()

ZarrsResult zarrsCreateShardIndexCache ( ZarrsArray  array,
ZarrsShardIndexCache *  pShardIndexCache 
)

Create a handle to a new shard index cache.

Errors

Returns an error if the array does not have read capability.

Safety

array must be a valid ZarrsArray handle.

◆ zarrsCreateStorageFilesystem()

ZarrsResult zarrsCreateStorageFilesystem ( const char *  path,
ZarrsStorage *  pStorage 
)

Create a storage handle to a filesystem store.

pStorage is a pointer to a handle in which the created ZarrsStorage is returned.

Safety

pStorage must be a valid pointer to a ZarrsStorage handle.

◆ zarrsDestroyArray()

ZarrsResult zarrsDestroyArray ( ZarrsArray  array)

Destroy array.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if array is a null pointer.

Safety

If not null, array must be a valid ZarrsArray handle.

◆ zarrsDestroyShardIndexCache()

ZarrsResult zarrsDestroyShardIndexCache ( ZarrsShardIndexCache  shardIndexCache)

Destroy a shard index cache.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if shardIndexCache is a null pointer.

Safety

If not null, shardIndexCache must be a valid ZarrsShardIndexCache handle.

◆ zarrsDestroyStorage()

ZarrsResult zarrsDestroyStorage ( ZarrsStorage  storage)

Destroy storage.

Errors

Returns ZarrsResult::ZARRS_ERROR_NULL_PTR if storage is a null pointer.

Safety

If not null, storage must be a valid storage device created with a zarrsStorage function.

◆ zarrsFreeString()

ZarrsResult zarrsFreeString ( char *  string)

Free a string created by zarrs.

Safety

array must be a valid string created by zarrs.

◆ zarrsLastError()

char* zarrsLastError ( void  )

Get the last error string.

The string must be freed with zarrsFreeString.

◆ zarrsOpenArrayRW()

ZarrsResult zarrsOpenArrayRW ( ZarrsStorage  storage,
const char *  path,
ZarrsArray *  pArray 
)

Create a handle to an existing array (read/write capability).

pArray is a pointer to a handle in which the created ZarrsArray is returned.

Safety

pArray must be a valid pointer to a ZarrsArray handle.

◆ zarrsVersion()

uint32_t zarrsVersion ( void  )

Get the zarrs version.

A u32 representation of the version encoded as (zarrsVersionMajor() << 22) | (zarrsVersionMinor() << 12) | zarrsVersionPatch().

◆ zarrsVersionMajor()

uint32_t zarrsVersionMajor ( void  )

Get the zarrs major version.

◆ zarrsVersionMinor()

uint32_t zarrsVersionMinor ( void  )

Get the zarrs minor version.

◆ zarrsVersionPatch()

uint32_t zarrsVersionPatch ( void  )

Get the zarrs patch version.