buffer-codec/com.ditchoom.buffer.codec

Package-level declarations

Types

interface Codec<T> : Encoder<T> , Decoder<T> , FrameDetector

Complete codec: encodes, decodes, and detects frame boundaries.

interface CodecContext

Base interface for typed key-value context that flows through codec chains.

interface DecodeContext : CodecContext

Context passed to Codec.decode for runtime configuration during decoding.

fun interface Decoder<out T>

Decodes typed messages from bytes.

interface EncodeContext : CodecContext

Context passed to Codec.encode for runtime configuration during encoding.

interface Encoder<in T>

Encodes typed messages to bytes.

sealed interface SizeEstimate

Result of estimating the encoded size of a message.

Functions

fun <T> Codec<T>.encodeToBuffer(value: T, factory: BufferFactory = BufferFactory.Default, context: EncodeContext = EncodeContext.Empty): ReadBuffer

fun <T> Codec<T>.testRoundTrip(value: T, expectedBytes: ByteArray? = null, factory: BufferFactory = BufferFactory.Default, decodeContext: DecodeContext = DecodeContext.Empty, encodeContext: EncodeContext = EncodeContext.Empty): T

Testing utility: encodes value, optionally verifies the wire bytes match expectedBytes, then decodes and returns the result. Intended for use in test suites to validate codec correctness.