Kafka.Record.Response

Documentation

data Record

Information about Record from Kafka documentation:

length: varint
attributes: int8
    bit 0~7: unused
timestampDelta: varlong
offsetDelta: varint
keyLength: varint
key: byte[]
valueLen: varint
value: byte[]
Headers => [Header]

Constructors

Record

Fields

• attributes :: !Word8

  To the author's understanding, record attributes are unused, and this will always be zero. But just to be safe, this library parses it from the encoded record.

• timestampDelta :: !Int64
• offsetDelta :: !Int64

  We deviate from the spec here by making this a 64-bit integer instead of a 32-bit integer. We do this so that the integral type is wide enough to hold an absolute offset.

• key :: !Bytes

  We decode a null key to the empty byte sequence.

• value :: !Bytes
• headers :: !(SmallArray Header)

Instances

Show Record

Defined in Kafka.Record.Response

Methods

showsPrec :: Int -> Record -> ShowS

show :: Record -> String

showList :: [Record] -> ShowS

data Header

Information about Header from Kafka documentation:

headerKeyLength: varint
headerKey: String
headerValueLength: varint
value: byte[]

Constructors

Header

Fields

• key :: !Text

  Header key.

• value :: !Bytes

  Header value.

Instances

Show Header

Defined in Kafka.Record.Response

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Decode

Relative Offsets

decodeArray :: Bytes -> Maybe (SmallArray Record)

This consumes the entire input. If it succeeds, there were no leftovers.

Decode

Absolute Offsets

decodeArrayAbsolute

Arguments

:: Int64

Base timestamp (from record batch)

-> Int64

Base offset (from record batch)

-> Bytes

-> Maybe (SmallArray Record)

Variant of decodeArray that converts the timestamp and offset deltas to absolute timestamps and offsets. In the resulting records, the fields $sel:timestampDelta:Record and $sel:offsetDelta:Record are misnomers.