buffer-compression/com.ditchoom.buffer.compression/StreamingCompressor

StreamingCompressor

interface StreamingCompressor : AutoCloseable

Stateful streaming compressor that processes data incrementally. Useful for compressing data that arrives in chunks (e.g., from network).

Usage:

val compressor = StreamingCompressor.create()
try {
    while (hasMoreData) {
        val chunk = receiveChunk()
        compressor.compress(chunk) { compressedChunk ->
            send(compressedChunk)
        }
    }
    compressor.finish { finalChunk ->
        send(finalChunk)
    }
} finally {
    compressor.close()
}

Types

Companion

object Companion

Properties

allocator

abstract val allocator: BufferAllocator

The buffer allocator used by this compressor.

Functions

expect abstract fun close()

compress

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

Compresses input data, invoking the callback for each output chunk. May invoke callback zero or more times depending on buffering.

finish

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

Finishes compression, flushing any buffered data. Must be called after all input has been provided.

flush

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

Flushes buffered data using Z_SYNC_FLUSH, producing complete deflate blocks. Unlike finish, the stream remains open for more data.

reset

abstract fun reset()

Resets the compressor to initial state for reuse. More efficient than creating a new compressor.

use

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

Convenience function that handles compress, finish, and close automatically. All output chunks (from both compress and finish) go to the same callback.

useSuspending

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

Suspending version of use for use with suspending I/O. Uses the efficient synchronous compressor but allows suspend calls in the block.