Data.Text.StreamDecoding

Provides a stream-based approach to decoding Unicode data. Each function below works the same way: you give it a chunk of data, and it gives back a DecodeResult. If the parse was a success, then you get a chunk of Text (possibly empty) and a continuation parsing function. If the parse was a failure, you get a chunk of successfully decoded Text (possibly empty) and the unconsumed bytes.

In order to indicate end of stream, you pass an empty ByteString to the decode function. This call may result in a failure, if there were unused bytes left over from a previous step which formed part of a code sequence.

Streaming

streamUtf8 :: ByteString -> DecodeResult

O(n) Convert a lazy ByteString into a 'Stream Char', using UTF-8 encoding.

streamUtf8Pure :: ByteString -> DecodeResult

O(n) Convert a lazy ByteString into a 'Stream Char', using UTF-8 encoding.

streamUtf16LE :: ByteString -> DecodeResult

O(n) Convert a ByteString into a 'Stream Char', using little endian UTF-16 encoding.

streamUtf16BE :: ByteString -> DecodeResult

O(n) Convert a ByteString into a 'Stream Char', using big endian UTF-16 encoding.

streamUtf32LE :: ByteString -> DecodeResult

O(n) Convert a ByteString into a 'Stream Char', using little endian UTF-32 encoding.

streamUtf32BE :: ByteString -> DecodeResult

O(n) Convert a ByteString into a 'Stream Char', using big endian UTF-32 encoding.

Type

data DecodeResult

Constructors

DecodeResultSuccess !Text !(ByteString -> DecodeResult)

DecodeResultFailure !Text !ByteString