Structs§
Constants§
- BZ3_
ERR_ BWT - BZ3_
ERR_ CRC - BZ3_
ERR_ DATA_ SIZE_ TOO_ SMALL - BZ3_
ERR_ DATA_ TOO_ BIG - BZ3_
ERR_ INIT - BZ3_
ERR_ MALFORMED_ HEADER - BZ3_
ERR_ OUT_ OF_ BOUNDS - BZ3_
ERR_ TRUNCATED_ DATA - BZ3_OK
- INT8_
MAX - INT8_
MIN - INT16_
MAX - INT16_
MIN - INT32_
MAX - INT32_
MIN - INTPTR_
MAX - INTPTR_
MIN - INT_
FAST8_ MAX - INT_
FAST8_ MIN - INT_
FAST16_ MAX - INT_
FAST16_ MIN - INT_
FAST32_ MAX - INT_
FAST32_ MIN - INT_
LEAS T8_ MAX - INT_
LEAS T8_ MIN - INT_
LEAS T16_ MAX - INT_
LEAS T16_ MIN - INT_
LEAS T32_ MAX - INT_
LEAS T32_ MIN - PTRDIFF_
MAX - PTRDIFF_
MIN - SIG_
ATOMIC_ MAX - SIG_
ATOMIC_ MIN - SIZE_
MAX - UINT8_
MAX - UINT16_
MAX - UINT32_
MAX - UINTPTR_
MAX - UINT_
FAST8_ MAX - UINT_
FAST16_ MAX - UINT_
FAST32_ MAX - UINT_
LEAS T8_ MAX - UINT_
LEAS T16_ MAX - UINT_
LEAS T32_ MAX - WINT_
MAX - WINT_
MIN - _ATFILE_
SOURCE - _BITS_
STDINT_ INTN_ H - _BITS_
STDINT_ LEAST_ H - _BITS_
STDINT_ UINTN_ H - _BITS_
TIME64_ H - _BITS_
TYPESIZES_ H - _BITS_
TYPES_ H - _BITS_
WCHAR_ H - _DEFAULT_
SOURCE - _FEATURES_
H - _POSIX_
C_ SOURCE - _POSIX_
SOURCE - _STDC_
PREDEF_ H - _STDINT_
H - _SYS_
CDEFS_ H - __
FD_ SETSIZE - __
GLIBC_ MINOR__ - __
GLIBC_ USE_ C2X_ STRTOL - __
GLIBC_ USE_ DEPRECATED_ GETS - __
GLIBC_ USE_ DEPRECATED_ SCANF - __
GLIBC_ USE_ IEC_ 60559_ BFP_ EXT - __
GLIBC_ USE_ IEC_ 60559_ BFP_ EXT_ C2X - __
GLIBC_ USE_ IEC_ 60559_ EXT - __
GLIBC_ USE_ IEC_ 60559_ FUNCS_ EXT - __
GLIBC_ USE_ IEC_ 60559_ FUNCS_ EXT_ C2X - __
GLIBC_ USE_ IEC_ 60559_ TYPES_ EXT - __
GLIBC_ USE_ ISOC2X - __
GLIBC_ USE_ LIB_ EXT2 - __
GLIBC__ - __
GNU_ LIBRARY__ - __
HAVE_ GENERIC_ SELECTION - __
INO_ T_ MATCHES_ INO64_ T - __
KERNEL_ OLD_ TIMEVAL_ MATCHES_ TIMEVA L64 - __
LDOUBLE_ REDIRECTS_ TO_ FLOA T128_ ABI - __
OFF_ T_ MATCHES_ OFF64_ T - __
RLIM_ T_ MATCHES_ RLIM64_ T - __
STATFS_ MATCHES_ STATF S64 - __
STDC_ IEC_ 559_ COMPLEX__ - __
STDC_ IEC_ 559__ - __
STDC_ IEC_ 60559_ BFP__ - __
STDC_ IEC_ 60559_ COMPLEX__ - __
STDC_ ISO_ 10646__ - __
SYSCALL_ WORDSIZE - __
TIMESIZE - __
USE_ ATFILE - __
USE_ FORTIFY_ LEVEL - __
USE_ ISOC11 - __
USE_ ISOC95 - __
USE_ ISOC99 - __
USE_ MISC - __
USE_ POSIX - __
USE_ POSI X2 - __
USE_ POSI X199309 - __
USE_ POSI X199506 - __
USE_ POSIX_ IMPLICITLY - __
USE_ XOPE N2K - __
USE_ XOPE N2K8 - __
WORDSIZE - __
WORDSIZE_ TIME64_ COMPA T32 - __
glibc_ c99_ flexarr_ available
Functions§
- bz3_
bound ⚠ - @brief Return the recommended size of the output buffer for the compression functions.
- bz3_
compress ⚠ - @brief Compress a frame. This function does not support parallelism
by itself, consider using the low level
bz3_encode_blocks()
function instead. Using the low level API might provide better performance. Returns a bzip3 error code; BZ3_OK when the operation is successful. Make sure to set out_size to the size of the output buffer before the operation; out_size must be at least equal to `bz3_bound(in_size)’. - bz3_
decode_ ⚠block - @brief Decode a single block.
- bz3_
decode_ ⚠blocks - @brief Decode
n' blocks, all in parallel. Same specifics as
bz3_encode_blocks’, but doesn’t overwrite `sizes’. - bz3_
decompress ⚠ - @brief Decompress a frame. This function does not support parallelism
by itself, consider using the low level
bz3_decode_blocks()
function instead. Using the low level API might provide better performance. Returns a bzip3 error code; BZ3_OK when the operation is successful. Make sure to set out_size to the size of the output buffer before the operation. - bz3_
encode_ ⚠block - @brief Encode a single block. Returns the amount of bytes written to
buffer'.
buffer’ must be able to hold at least `bz3_bound(size)’ bytes. The size must not exceed the block size associated with the state. - bz3_
encode_ ⚠blocks - @brief Encode
n' blocks, all in parallel. All specifics of the
bz3_encode_block’ still hold. The function will launch a thread for each block. The compressed sizes are written to thesizes' array. Every buffer is overwritten and none of them can overlap. Precisely
n’ states, buffers and sizes must be supplied. - bz3_
free ⚠ - @brief Free the memory occupied by a block encoder state.
- bz3_
last_ ⚠error - @brief Get the last error number associated with a given state.
- bz3_
min_ ⚠memory_ needed - @brief Calculate the minimal memory required for compression with the given block size.
This includes all internal buffers and state structures. This calculates the amount of bytes
that will be allocated by a call to
bz3_new()
. - bz3_new⚠
- @brief Construct a new block encoder state, which will encode blocks as big as the given block size. The decoder will be able to decode blocks at most as big as the given block size. Returns NULL in case allocation fails or the block size is not between 65K and 511M
- bz3_
orig_ ⚠size_ sufficient_ for_ decode - @brief Check if using original file size as buffer size is sufficient for decompressing
a block at
block
pointer. - bz3_
strerror ⚠ - @brief Return a user-readable message explaining the cause of the last error.
- bz3_
version ⚠ - @brief Get bzip3 version.
Type Aliases§
- __
blkcnt64_ t - __
blkcnt_ t - __
blksize_ t - __
caddr_ t - __
clock_ t - __
clockid_ t - __
daddr_ t - __dev_t
- __
fsblkcnt64_ t - __
fsblkcnt_ t - __
fsfilcnt64_ t - __
fsfilcnt_ t - __
fsword_ t - __gid_t
- __id_t
- __
ino64_ t - __ino_t
- __
int8_ t - __
int16_ t - __
int32_ t - __
int64_ t - __
int_ least8_ t - __
int_ least16_ t - __
int_ least32_ t - __
int_ least64_ t - __
intmax_ t - __
intptr_ t - __key_t
- __
loff_ t - __
mode_ t - __
nlink_ t - __
off64_ t - __off_t
- __pid_t
- __
quad_ t - __
rlim64_ t - __
rlim_ t - __
sig_ atomic_ t - __
socklen_ t - __
ssize_ t - __
suseconds64_ t - __
suseconds_ t - __
syscall_ slong_ t - __
syscall_ ulong_ t - __
time_ t - __
timer_ t - __
u_ char - __u_int
- __
u_ long - __
u_ quad_ t - __
u_ short - __uid_t
- __
uint8_ t - __
uint16_ t - __
uint32_ t - __
uint64_ t - __
uint_ least8_ t - __
uint_ least16_ t - __
uint_ least32_ t - __
uint_ least64_ t - __
uintmax_ t - __
useconds_ t - int_
fast8_ t - int_
fast16_ t - int_
fast32_ t - int_
fast64_ t - int_
least8_ t - int_
least16_ t - int_
least32_ t - int_
least64_ t - intmax_
t - uint_
fast8_ t - uint_
fast16_ t - uint_
fast32_ t - uint_
fast64_ t - uint_
least8_ t - uint_
least16_ t - uint_
least32_ t - uint_
least64_ t - uintmax_
t - wchar_t