Package org.lwjgl.util.zstd

@NullMarked package org.lwjgl.util.zstd

Contains bindings to Zstandard (zstd), a fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios.

Zstandard is a real-time compression algorithm, providing high compression ratios. It offers a very wide range of compression / speed trade-off, while being backed by a very fast decoder. It also offers a special mode for small data, called dictionary compression, and can create dictionaries from any sample set.

Resources

• Documentation
• Source Repository

Class	Description
Zdict
ZDICTCoverParams	struct ZDICT_cover_params_t { unsigned k; unsigned d; unsigned steps; unsigned nbThreads; double splitPoint; {@link ZDICTParams ZDICT_params_t} zParams; }
ZDICTCoverParams.Buffer	An array of ZDICTCoverParams structs.
ZDICTFastCoverParams	struct ZDICT_fastCover_params_t { unsigned k; unsigned d; unsigned f; unsigned steps; unsigned nbThreads; double splitPoint; unsigned accel; {@link ZDICTParams ZDICT_params_t} zParams; }
ZDICTFastCoverParams.Buffer	An array of ZDICTFastCoverParams structs.
ZDICTParams	struct ZDICT_params_t { int compressionLevel; unsigned notificationLevel; unsigned dictID; }
ZDICTParams.Buffer	An array of ZDICTParams structs.
Zstd
ZSTDAllocFunction	Callback function: ZSTD_allocFunction
ZSTDAllocFunctionI	Callback function: ZSTD_allocFunction
ZSTDBounds	struct ZSTD_bounds { size_t error; int lowerBound; int upperBound; }
ZSTDBounds.Buffer	An array of ZSTDBounds structs.
ZSTDCompressionParameters	struct ZSTD_compressionParameters { unsigned int windowLog; unsigned int chainLog; unsigned int hashLog; unsigned int searchLog; unsigned int minMatch; unsigned int targetLength; ZSTD_strategy strategy; }
ZSTDCompressionParameters.Buffer	An array of ZSTDCompressionParameters structs.
ZSTDCustomMem	struct ZSTD_customMem { {@link ZSTDAllocFunctionI ZSTD_allocFunction} customAlloc; {@link ZSTDFreeFunctionI ZSTD_freeFunction} customFree; void * opaque; }
ZSTDCustomMem.Buffer	An array of ZSTDCustomMem structs.
ZstdErrors
ZSTDFrameHeader	struct ZSTD_FrameHeader { unsigned long long frameContentSize; unsigned long long windowSize; unsigned int blockSizeMax; ZSTD_FrameType_e frameType; unsigned int headerSize; unsigned int dictID; unsigned int checksumFlag; unsigned _reserved1; unsigned _reserved2; }
ZSTDFrameHeader.Buffer	An array of ZSTDFrameHeader structs.
ZSTDFrameParameters	struct ZSTD_frameParameters { int contentSizeFlag; int checksumFlag; int noDictIDFlag; }
ZSTDFrameParameters.Buffer	An array of ZSTDFrameParameters structs.
ZSTDFrameProgression	struct ZSTD_frameProgression { unsigned long long ingested; unsigned long long consumed; unsigned long long produced; unsigned long long flushed; unsigned int currentJobID; unsigned int nbActiveWorkers; }
ZSTDFrameProgression.Buffer	An array of ZSTDFrameProgression structs.
ZSTDFreeFunction	Callback function: ZSTD_freeFunction
ZSTDFreeFunctionI	Callback function: ZSTD_freeFunction
ZSTDInBuffer	struct ZSTD_inBuffer { void const * src; size_t size; size_t pos; }
ZSTDInBuffer.Buffer	An array of ZSTDInBuffer structs.
ZSTDOutBuffer	struct ZSTD_outBuffer { void * dst; size_t size; size_t pos; }
ZSTDOutBuffer.Buffer	An array of ZSTDOutBuffer structs.
ZSTDParameters	struct ZSTD_parameters { {@link ZSTDCompressionParameters ZSTD_compressionParameters} cParams; {@link ZSTDFrameParameters ZSTD_frameParameters} fParams; }
ZSTDParameters.Buffer	An array of ZSTDParameters structs.
ZSTDSequence	struct ZSTD_Sequence { unsigned int offset; unsigned int litLength; unsigned int matchLength; unsigned int rep; }
ZSTDSequence.Buffer	An array of ZSTDSequence structs.
ZSTDSequenceProducer	Callback function: ZSTD_sequenceProducer_F
ZSTDSequenceProducerI	Callback function: ZSTD_sequenceProducer_F
ZstdX