buffer-compression/com.ditchoom.buffer.compression/StreamingDecompressor

StreamingDecompressor

interface StreamingDecompressor : AutoCloseable

Stateful streaming decompressor that processes data incrementally.

Types

object Companion

Properties

abstract val bufferFactory: BufferFactory

The buffer factory used by this decompressor.

Functions

expect abstract fun close()

abstract fun decompress(input: ReadBuffer, onOutput: (ReadBuffer) -> Unit)

Decompresses input data, invoking the callback for each output chunk.

abstract fun finish(onOutput: (ReadBuffer) -> Unit)

Finishes decompression, validating completeness.

open fun flush(onOutput: (ReadBuffer) -> Unit)

Emits any buffered partial output without finalizing the stream.

abstract fun reset()

Resets the decompressor to initial state for reuse.

inline fun <R> StreamingDecompressor.use(noinline onOutput: (ReadBuffer) -> Unit, block: (decompress: (ReadBuffer) -> Unit) -> R): R

Convenience function that handles decompress, finish, and close automatically.

inline suspend fun <R> StreamingDecompressor.useSuspending(noinline onOutput: (ReadBuffer) -> Unit, block: suspend (decompress: (ReadBuffer) -> Unit) -> R): R

Suspending version of use for use with suspending I/O.