Interface DiscordZstd

@NullMarked
public interface DiscordZstd

Main interface which allows creating decompression contexts, and decompressor factories.

Method Summary

Modifier and Type	Method	Description
DiscordZstdContext	createContext()	Creates a new DiscordZstdContext.
DiscordZstdDecompressorFactory	createDecompressorFactory(int bufferSizeHint)	Creates a new DiscordZstdDecompressorFactory with the provided decompression buffer size.

Method Details

createContext

DiscordZstdContext createContext()

Creates a new DiscordZstdContext.
This is used to keep track of streaming decompression after each input is consumed via an InputStream.

Returns:

A new DiscordZstdContext instance

createDecompressorFactory

DiscordZstdDecompressorFactory createDecompressorFactory(int bufferSizeHint)

Creates a new DiscordZstdDecompressorFactory with the provided decompression buffer size.

Parameters:

bufferSizeHint - A hint for the size of the buffer used for decompression, must be larger than 1024 or be equal to -2.
Typically, bigger buffers mean less decompression loops, it does not change inputs or outputs

Returns:

A new DiscordZstdDecompressorFactory instance

Throws:

IllegalArgumentException - If bufferSize is less than 1024 and not -2