GHC.RTS.Events.Incremental

Incremental API

data Decoder a

The unfolding of the decoding process.

Constructors

Consume (ByteString -> Decoder a)

The decoder has consumed all the available input and needs more to continue.

Produce !a (Decoder a)

The decoder has returned a decoded value and the next decoder state to continue.

Done ByteString

The decoder has ended with leftover input.

Error ByteString String

The decoder has encountered an error with leftover input and an error message.

decodeHeader :: Decoder Header

Decode a header

decodeEvents :: Header -> Decoder Event

Decode events

decodeEventLog :: Decoder Event

Decode a header and events

Lazy API

readHeader :: ByteString -> Either String (Header, ByteString)

Read a header from a lazy bytestring and return the header and the leftover input for subsequent decoding.

Note that the input must contain a whole header in one go. If incremental parsing of a header is necessary, use decodeHeader instead.

readEvents :: Header -> ByteString -> ([Event], Maybe String)

Read events from a lazy bytestring. It returns an error message if it encounters an error while decoding the header.

Note that it doesn't fail if it consumes all input in the middle of decoding of an event.

readEvents' :: Header -> ByteString -> [Either String Event]

Read events from a lazy bytestring. It returns an error message if it encounters an error while decoding the header.

Note that it doesn't fail if it consumes all input in the middle of decoding of an event.

readEventLog :: ByteString -> Either String (EventLog, Maybe String)

Read an entire event log from a lazy bytestring. It returns an error message if it encounters an error while decoding.

Note that it doesn't fail if it consumes all input in the middle of decoding of an event.

readEventLogOrFail :: ByteString -> Either String EventLog

Read an entire event log from a lazy bytestring. It returns an error message if it encounters an error while decoding.

This will raise an error if a malformed event is encountered during decoding.