buffer-compression/com.ditchoom.buffer.compression/create

create

expect fun StreamingCompressor.Companion.create(algorithm: CompressionAlgorithm = CompressionAlgorithm.Deflate, level: CompressionLevel = CompressionLevel.Default, bufferFactory: BufferFactory = BufferFactory.Default, outputBufferSize: Int = 32768, windowBits: WindowBits = WindowBits.Default): StreamingCompressor

Creates a streaming compressor.

Parameters

algorithm

The compression algorithm to use.

level

The compression level.

bufferFactory

Factory for allocating output buffers.

outputBufferSize

Size of output buffers (default 32KB).

windowBits

Log2 size of the LZ77 sliding window. WindowBits.Default selects the algorithm default (15-bit / 32 KB window). The platform applies the algorithm-appropriate sign/offset to zlib's deflateInit2 (see resolveWindowBits). Note: JVM's java.util.zip.Deflater does not support custom window sizes; this parameter is silently ignored on JVM. Apple and JS/Wasm also currently ignore it.

expect fun StreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm = CompressionAlgorithm.Deflate, bufferFactory: BufferFactory = BufferFactory.Default, outputBufferSize: Int = 32768, expectedSize: Int = 0): StreamingDecompressor

Creates a streaming decompressor.

Parameters

algorithm

The compression algorithm to use.

bufferFactory

Factory for allocating output buffers.

outputBufferSize

Size of output buffers (default 32KB).

expectedSize

Optional hint for expected decompressed size. Used to pre-allocate buffers.

expect fun SuspendingStreamingCompressor.Companion.create(algorithm: CompressionAlgorithm = CompressionAlgorithm.Deflate, level: CompressionLevel = CompressionLevel.Default, bufferFactory: BufferFactory = BufferFactory.Default): SuspendingStreamingCompressor

Creates a suspending streaming compressor. Required for browser JavaScript which only supports async CompressionStream.

expect fun SuspendingStreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm = CompressionAlgorithm.Deflate, bufferFactory: BufferFactory = BufferFactory.Default): SuspendingStreamingDecompressor

Creates a suspending streaming decompressor.

actual fun StreamingCompressor.Companion.create(algorithm: CompressionAlgorithm, level: CompressionLevel, bufferFactory: BufferFactory, outputBufferSize: Int, windowBits: WindowBits): StreamingCompressor

Creates a streaming compressor.

Parameters

algorithm

The compression algorithm to use.

level

The compression level.

bufferFactory

Factory for allocating output buffers.

outputBufferSize

Size of output buffers (default 32KB).

windowBits

actual fun StreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm, bufferFactory: BufferFactory, outputBufferSize: Int, expectedSize: Int): StreamingDecompressor

Creates a streaming decompressor.

Parameters

algorithm

The compression algorithm to use.

bufferFactory

Factory for allocating output buffers.

outputBufferSize

Size of output buffers (default 32KB).

expectedSize

Optional hint for expected decompressed size. Used to pre-allocate buffers.

actual fun SuspendingStreamingCompressor.Companion.create(algorithm: CompressionAlgorithm, level: CompressionLevel, bufferFactory: BufferFactory): SuspendingStreamingCompressor

Creates a suspending streaming compressor. Required for browser JavaScript which only supports async CompressionStream.

actual fun SuspendingStreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm, bufferFactory: BufferFactory): SuspendingStreamingDecompressor

Creates a suspending streaming decompressor.

actual fun StreamingCompressor.Companion.create(algorithm: CompressionAlgorithm, level: CompressionLevel, bufferFactory: ERROR CLASS: Symbol not found for BufferFactory, outputBufferSize: Int, windowBits: WindowBits): StreamingCompressor

actual fun StreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm, bufferFactory: ERROR CLASS: Symbol not found for BufferFactory, outputBufferSize: Int, expectedSize: Int): StreamingDecompressor

actual fun SuspendingStreamingCompressor.Companion.create(algorithm: CompressionAlgorithm, level: CompressionLevel, bufferFactory: ERROR CLASS: Symbol not found for BufferFactory): SuspendingStreamingCompressor

actual fun SuspendingStreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm, bufferFactory: ERROR CLASS: Symbol not found for BufferFactory): SuspendingStreamingDecompressor

Linux streaming compressor factory using z_stream for true incremental compression.

actual fun StreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm, bufferFactory: BufferFactory, outputBufferSize: Int, expectedSize: Int): StreamingDecompressor

Linux streaming decompressor factory using z_stream for true incremental decompression.

actual fun SuspendingStreamingCompressor.Companion.create(algorithm: CompressionAlgorithm, level: CompressionLevel, bufferFactory: BufferFactory): SuspendingStreamingCompressor

Creates a suspending streaming compressor. Required for browser JavaScript which only supports async CompressionStream.

actual fun SuspendingStreamingDecompressor.Companion.create(algorithm: CompressionAlgorithm, bufferFactory: BufferFactory): SuspendingStreamingDecompressor

Creates a suspending streaming decompressor.