zxc_error.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * ZXC - High-performance lossless compression
 *
 * Copyright (c) Bertrand Lebonnois and contributors.
 */
 
#ifndef ZXC_ERROR_H
#define ZXC_ERROR_H
 
#include "zxc_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    ZXC_OK = 0, 
    /* Memory errors */
    ZXC_ERROR_MEMORY = -1, 
    /* Buffer/capacity errors */
    ZXC_ERROR_DST_TOO_SMALL = -2, 
    ZXC_ERROR_SRC_TOO_SMALL = -3, 
    /* Format/header errors */
    ZXC_ERROR_BAD_MAGIC = -4,    
    ZXC_ERROR_BAD_VERSION = -5,  
    ZXC_ERROR_BAD_HEADER = -6,   
    ZXC_ERROR_BAD_CHECKSUM = -7, 
    /* Data integrity errors */
    ZXC_ERROR_CORRUPT_DATA = -8, 
    ZXC_ERROR_BAD_OFFSET = -9,   
    ZXC_ERROR_OVERFLOW = -10,    
    /* I/O errors */
    ZXC_ERROR_IO = -11,         
    ZXC_ERROR_NULL_INPUT = -12, 
    /* Block errors */
    ZXC_ERROR_BAD_BLOCK_TYPE = -13, 
    ZXC_ERROR_BAD_BLOCK_SIZE = -14, 
    /* Dictionary errors */
    ZXC_ERROR_DICT_REQUIRED = -15,  
    ZXC_ERROR_DICT_MISMATCH = -16,  
    ZXC_ERROR_DICT_TOO_LARGE = -17, 
    /* Parameter errors */
    ZXC_ERROR_BAD_LEVEL = -18, 
    ZXC_ERROR_DICT_UNSUPPORTED = -19, 
} zxc_error_t;
 
ZXC_EXPORT const char* zxc_error_name(const int code);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZXC_ERROR_H */