Top Description Interfaces Classes
module lwjgl.zstd

Package org.lwjgl.util.zstd

Annotations
@NonnullDefault

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.

Interface Summary

Modifier and TypeInterface and Description
public interface
ZSTDAllocFunctionI

Instances of this interface may be passed to the ZSTDCustomMem struct.

public interface
ZSTDFreeFunctionI

Instances of this interface may be passed to the ZSTDCustomMem struct.

public interface
ZSTDSequenceProducerI

Type


void * (*invoke) (
    void *sequenceProducerState,
    ZSTD_Sequence *outSeqs,
    size_t outSeqsCapacity,
    void const *src,
    size_t srcSize,
    void const *dict,
    size_t dictSize,
    int compressionLevel,
    size_t windowSize
)

Class Summary

Modifier and TypeClass and Description
pack-priv class
LibZstd

Initializes the zstd shared library.

public class
Zdict

Native bindings to the dictionary builder API of Zstandard (zstd).

public class
ZDICTCoverParams

k and d are the only required parameters.

public class
ZDICTFastCoverParams

k and d are the only required parameters.

public class
ZDICTParams

Layout


struct ZDICT_params_t {
    int compressionLevel;
    unsigned notificationLevel;
    unsigned dictID;
}
public class
Zstd

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

public abstract class
ZSTDAllocFunction

Instances of this class may be passed to the ZSTDCustomMem struct.

public class
ZSTDBounds

Layout


struct ZSTD_bounds {
    size_t error;
    int lowerBound;
    int upperBound;
}
public class
ZSTDCompressionParameters

Layout


struct ZSTD_compressionParameters {
    unsigned int windowLog;
    unsigned int chainLog;
    unsigned int hashLog;
    unsigned int searchLog;
    unsigned int minMatch;
    unsigned int targetLength;
    ZSTD_strategy strategy;
}
public class
ZSTDCustomMem

Layout


struct ZSTD_customMem {
    ZSTD_allocFunction customAlloc;
    ZSTD_freeFunction customFree;
    void * opaque;
}
public class
ZstdErrors

Native bindings to the experimental error code API of Zstandard (zstd).

public class
ZSTDFrameHeader

Layout


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;
}
public class
ZSTDFrameParameters

Layout


struct ZSTD_frameParameters {
    int contentSizeFlag;
    int checksumFlag;
    int noDictIDFlag;
}
public class
ZSTDFrameProgression

Layout


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;
}
public abstract class
ZSTDFreeFunction

Instances of this class may be passed to the ZSTDCustomMem struct.

public class
ZSTDInBuffer

Layout


struct ZSTD_inBuffer {
    void const * src;
    size_t size;
    size_t pos;
}
public class
ZSTDOutBuffer

Layout


struct ZSTD_outBuffer {
    void * dst;
    size_t size;
    size_t pos;
}
public class
ZSTDParameters

Layout


struct ZSTD_parameters {
    ZSTD_compressionParameters cParams;
    ZSTD_frameParameters fParams;
}
public class
ZSTDSequence

Layout


struct ZSTD_Sequence {
    unsigned int offset;
    unsigned int litLength;
    unsigned int matchLength;
    unsigned int rep;
}
public abstract class
ZSTDSequenceProducer

Type


void * (*invoke) (
    void *sequenceProducerState,
    ZSTD_Sequence *outSeqs,
    size_t outSeqsCapacity,
    void const *src,
    size_t srcSize,
    void const *dict,
    size_t dictSize,
    int compressionLevel,
    size_t windowSize
)
public class
ZstdX

Native bindings to the experimental API of Zstandard (zstd).