buffer-compression/com.ditchoom.buffer.compression/SuspendingStreamingCompressor

SuspendingStreamingCompressor

interface SuspendingStreamingCompressor : AutoCloseable

Suspending streaming compressor for async-only platforms. Browser JavaScript requires this variant since CompressionStream is async.

Usage:

val compressor = SuspendingStreamingCompressor.create()
try {
    while (hasMoreData) {
        val chunk = receiveChunk()
        compressor.compress(chunk).forEach { send(it) }
    }
    compressor.finish().forEach { send(it) }
} finally {
    compressor.close()
}

Types

Companion

object Companion

Properties

bufferFactory

abstract val bufferFactory: BufferFactory

Functions

expect abstract fun close()

compress

abstract suspend fun compress(input: ReadBuffer): List<ReadBuffer>

Compresses input data, returning output chunks. May return empty list if data is buffered.

finish

abstract suspend fun finish(): List<ReadBuffer>

Finishes compression, returning any remaining data.

flush

abstract suspend fun flush(): List<ReadBuffer>

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 for reuse.

use

inline suspend fun <R> SuspendingStreamingCompressor.use(block: (compress: suspend (ReadBuffer) -> List<ReadBuffer>) -> R): R

Convenience function that handles compress, finish, and close automatically. Returns all output chunks (from both compress and finish calls).