region.h

Go to the documentation of this file.

 
#ifndef CLOD_REGION_H
#define CLOD_REGION_H
 
#include <clod/compression.h>
#include <clod/lib.h>
#include <stdint.h>
#include <time.h>

#define CLOD_REGION_VERSION 1
 
struct clod_region;
struct clod_region_opts;
struct clod_region_iter;

enum clod_region_result {
    CLOD_REGION_OK = 0,
    CLOD_REGION_INVALID_USAGE = 1,
    CLOD_REGION_MALFORMED = 2,
    CLOD_REGION_NOT_FOUND = 3
};

CLOD_API CLOD_USE_RETURN
struct clod_region *
clod_region_open(const char *path, const struct clod_region_opts *opts);

CLOD_API CLOD_USE_RETURN CLOD_NONNULL(1, 2, 3)
enum clod_region_result
clod_region_read(struct clod_region *region, const int64_t *pos, uint8_t *buff, size_t buff_size, size_t *size);

CLOD_API CLOD_USE_RETURN CLOD_NONNULL(1, 2)
enum clod_region_result
clod_region_write(struct clod_region *region, const int64_t *pos, const uint8_t *buff, size_t buff_size);

CLOD_API CLOD_USE_RETURN CLOD_NONNULL(1, 2)
enum clod_region_result
clod_region_mtime(struct clod_region *region, const int64_t *pos, time_t *mtime);

CLOD_API CLOD_USE_RETURN CLOD_NONNULL(1)
struct clod_region_iter *
clod_region_iter_start(struct clod_region *region);

CLOD_API CLOD_USE_RETURN CLOD_NONNULL(1, 2)
bool
clod_region_iter_next(struct clod_region_iter *iter, int64_t *pos);

CLOD_API CLOD_NONNULL(1)
void
clod_region_iter_end(struct clod_region_iter *iter);

CLOD_API CLOD_NONNULL(1)
enum clod_region_result
clod_region_close(struct clod_region *region);

#define CLOD_REGION_MODE_RDONLY 1
#define CLOD_REGION_MODE_RDWR 2

#define CLOD_REGION_PREFIX_MAX 30
#define CLOD_REGION_EXTENSION_MAX 10
#define CLOD_REGION_DIMENSIONS_MAX 10

struct clod_region_opts {
    uint8_t version;

    uint8_t dims;

    uint8_t mode;

    enum clod_compression_method compression;

    uint32_t sector_size;

    int unix_fd;

    uint32_t unix_file_perms;

    char prefix[CLOD_REGION_PREFIX_MAX + 1];

    char region_ext[CLOD_REGION_EXTENSION_MAX + 1];

    char chunk_ext[CLOD_REGION_EXTENSION_MAX + 1];
};

#endif