Documentation

Given a decoder and an input buffer returns either the decoded value or an error (if the input buffer is not fully consumed)

Decode a list of values, one value at a time.

Useful in case that the decoded values takes a lot more memory than the encoded ones.

See ../test/Big.hs for a test and an example of use.

See also Flat.AsBin.

Since: 0.5

A decoded value

An exception during decoding

A decoder.

Given:

• end of input buffer
• current position in input buffer

Returns:

• decoded value
• new position in input buffer

Decode a Float

Decode a Double

Decode a boolean

Return the 8 most significant bits (same as dBE8)

Return the 8 most significant bits

Return the 16 most significant bits

Return the 32 most significant bits

Return the 64 most significant bits

Return the n most significant bits (up to maximum of 8)

The bits are returned right shifted:

>>> unflatWith (dBEBits8 3) [0b11100001::Word8] == Right 0b00000111
True

>>> unflatWith (dBEBits8 9) [0b11100001::Word8,0b11111111]
Left (BadOp "read8: cannot read 9 bits")

Return the n most significant bits (up to maximum of 16)

The bits are returned right shifted:

>>> pPrint . asBits <$> unflatWith (dBEBits16 11) [0b10110111::Word8,0b11100001]
Right 00000101 10111111

If more than 16 bits are requested, only the last 16 are returned:

>>> pPrint . asBits <$> unflatWith (dBEBits16 19) [0b00000000::Word8,0b11111111,0b11100001]
Right 00000111 11111111

Return the n most significant bits (up to maximum of 32) The bits are returned right shifted.

Return the n most significant bits (up to maximum of 64) The bits are returned right shifted.

Drop the specified number of bits

A special state, optimised for constructor decoding.

It consists of:

• The bits to parse, the top bit being the first to parse (could use a Word16 instead, no difference in performance)
• The number of decoded bits

Supports up to 512 constructors (9 bits).

Switch to constructor decoding {-# INLINE consOpen #-}

Switch back to normal decoding {-# NOINLINE consClose #-}

Decode a single bit

Decode from 1 to 3 bits

It could read more bits that are available, but it doesn't matter, errors will be checked in consClose.