Index

Modules: zxc, zxc/bindings.

API symbols

`$`:

• zxc: proc `$`(decompZscBytes: DecompZscBytes): string

bytesToString:

• zxc: proc bytesToString(b: openArray[byte]): string

compress:

• zxc: proc compress(s: string; output: var CompZscBytes; level: ZxcCompressionLevel = ZXC_LEVEL_DEFAULT; checksumEnabled = false)

compressBytes:

• zxc: proc compressBytes(input: openArray[byte]; output: var CompZscBytes; level: ZxcCompressionLevel; checksumEnabled: bool)

compressFile:

• zxc: proc compressFile(inputPath, outputPath: string; level: ZxcCompressionLevel = ZXC_LEVEL_DEFAULT; checksumEnabled = false)

compressStream:

• zxc: proc compressStream(fIn, fOut: File; level: ZxcCompressionLevel = ZXC_LEVEL_DEFAULT; nThreads: cint = 0; blockSize: csize_t = 0; checksumEnabled = true; seekable = false; progressCb: ZxcProgressCallback = nil; userData: pointer = nil): int64

compressString:

• zxc: proc compressString(s: string; level: ZxcCompressionLevel = ZXC_LEVEL_DEFAULT; checksumEnabled = false): CompZscBytes

CompZscBytes:

• zxc: type CompZscBytes

decompress:

• zxc: proc decompress(compressed: openArray[byte]; output: var DecompZscBytes; checksumEnabled: bool = false)

decompressBytes:

• zxc: proc decompressBytes(compressed: openArray[byte]; output: var DecompZscBytes; checksumEnabled: bool)

decompressFile:

• zxc: proc decompressFile(inputPath, outputPath: string; checksumEnabled = false)

decompressStream:

• zxc: proc decompressStream(fIn, fOut: File; nThreads: cint = 0; checksumEnabled = true; progressCb: ZxcProgressCallback = nil; userData: pointer = nil): int64

decompressString:

• zxc: proc decompressString(compressed: openArray[byte]; checksumEnabled: bool = false): string

DecompZscBytes:

• zxc: type DecompZscBytes

raiseZxc:

• zxc: proc raiseZxc(code: int64; msg: string)

stringToBytes:

• zxc: proc stringToBytes(s: string): seq[byte]

ZXC_BLOCK_SIZE_DEFAULT:

• bindings: const ZXC_BLOCK_SIZE_DEFAULT

ZXC_BLOCK_SIZE_MAX:

• bindings: const ZXC_BLOCK_SIZE_MAX

ZXC_BLOCK_SIZE_MAX_LOG2:

• bindings: const ZXC_BLOCK_SIZE_MAX_LOG2

ZXC_BLOCK_SIZE_MIN:

• bindings: const ZXC_BLOCK_SIZE_MIN

ZXC_BLOCK_SIZE_MIN_LOG2:

• bindings: const ZXC_BLOCK_SIZE_MIN_LOG2

zxc_cctx:

• bindings: object zxc_cctx

zxc_cctxPtr:

• bindings: type zxc_cctxPtr

zxc_compress:

• bindings: proc zxc_compress(src: pointer; src_size: csize_t; dst: pointer; dst_capacity: csize_t; opts: ptr zxc_compress_opts_t): int64

zxc_compress_block:

• bindings: proc zxc_compress_block(cctx: zxc_cctxPtr; src: pointer; src_size: csize_t; dst: pointer; dst_capacity: csize_t; opts: ptr zxc_compress_opts_t): int64

zxc_compress_block_bound:

• bindings: proc zxc_compress_block_bound(input_size: csize_t): uint64

zxc_compress_bound:

• bindings: proc zxc_compress_bound(input_size: csize_t): uint64

zxc_compress_cctx:

• bindings: proc zxc_compress_cctx(cctx: zxc_cctxPtr; src: pointer; src_size: csize_t; dst: pointer; dst_capacity: csize_t; opts: ptr zxc_compress_opts_t): int64

ZxcCompressionLevel:

• zxc: type ZxcCompressionLevel

zxc_compression_level_t:

• bindings: enum zxc_compression_level_t

zxc_compress_opts_t:

• bindings: object zxc_compress_opts_t

zxc_create_cctx:

• bindings: proc zxc_create_cctx(opts: ptr zxc_compress_opts_t): zxc_cctxPtr

zxc_create_dctx:

• bindings: proc zxc_create_dctx(): zxc_dctxPtr

zxc_dctx:

• bindings: object zxc_dctx

zxc_dctxPtr:

• bindings: type zxc_dctxPtr

zxc_decompress:

• bindings: proc zxc_decompress(src: pointer; src_size: csize_t; dst: pointer; dst_capacity: csize_t; opts: ptr zxc_decompress_opts_t): int64

zxc_decompress_block:

• bindings: proc zxc_decompress_block(dctx: zxc_dctxPtr; src: pointer; src_size: csize_t; dst: pointer; dst_capacity: csize_t; opts: ptr zxc_decompress_opts_t): int64

zxc_decompress_dctx:

• bindings: proc zxc_decompress_dctx(dctx: zxc_dctxPtr; src: pointer; src_size: csize_t; dst: pointer; dst_capacity: csize_t; opts: ptr zxc_decompress_opts_t): int64

zxc_decompress_opts_t:

• bindings: object zxc_decompress_opts_t

zxc_default_level:

• bindings: proc zxc_default_level(): cint

ZxcError:

• zxc: object ZxcError

ZXC_ERROR_BAD_BLOCK_SIZE:

• bindings: const ZXC_ERROR_BAD_BLOCK_SIZE

ZXC_ERROR_BAD_BLOCK_TYPE:

• bindings: const ZXC_ERROR_BAD_BLOCK_TYPE

ZXC_ERROR_BAD_CHECKSUM:

• bindings: const ZXC_ERROR_BAD_CHECKSUM

ZXC_ERROR_BAD_HEADER:

• bindings: const ZXC_ERROR_BAD_HEADER

ZXC_ERROR_BAD_MAGIC:

• bindings: const ZXC_ERROR_BAD_MAGIC

ZXC_ERROR_BAD_OFFSET:

• bindings: const ZXC_ERROR_BAD_OFFSET

ZXC_ERROR_BAD_VERSION:

• bindings: const ZXC_ERROR_BAD_VERSION

ZXC_ERROR_CORRUPT_DATA:

• bindings: const ZXC_ERROR_CORRUPT_DATA

ZXC_ERROR_DST_TOO_SMALL:

• bindings: const ZXC_ERROR_DST_TOO_SMALL

ZXC_ERROR_IO:

• bindings: const ZXC_ERROR_IO

ZXC_ERROR_MEMORY:

• bindings: const ZXC_ERROR_MEMORY

zxc_error_name:

• bindings: proc zxc_error_name(code: cint): cstring

ZXC_ERROR_NULL_INPUT:

• bindings: const ZXC_ERROR_NULL_INPUT

ZXC_ERROR_OVERFLOW:

• bindings: const ZXC_ERROR_OVERFLOW

ZXC_ERROR_SRC_TOO_SMALL:

• bindings: const ZXC_ERROR_SRC_TOO_SMALL

zxc_free_cctx:

• bindings: proc zxc_free_cctx(cctx: zxc_cctxPtr)

zxc_free_dctx:

• bindings: proc zxc_free_dctx(dctx: zxc_dctxPtr)

zxc_get_decompressed_size:

• bindings: proc zxc_get_decompressed_size(src: pointer; src_size: csize_t): uint64

zxc_max_level:

• bindings: proc zxc_max_level(): cint

zxc_min_level:

• bindings: proc zxc_min_level(): cint

zxc_nim_progress_cb_t:

• bindings: type zxc_nim_progress_cb_t

ZXC_OK:

• bindings: const ZXC_OK

ZxcProgressCallback:

• zxc: type ZxcProgressCallback

zxc_progress_callback_t:

• bindings: type zxc_progress_callback_t

zxc_stream_compress:

• bindings: proc zxc_stream_compress(f_in: ptr File; f_out: ptr File; opts: ptr zxc_compress_opts_t): int64

zxc_stream_decompress:

• bindings: proc zxc_stream_decompress(f_in: ptr File; f_out: ptr File; opts: ptr zxc_decompress_opts_t): int64

zxc_stream_get_decompressed_size:

• bindings: proc zxc_stream_get_decompressed_size(f_in: ptr File): int64

zxc_version_string:

• bindings: proc zxc_version_string(): cstring