Binrep.Type.Prefix

Documentation

class Prefix a where

Types which may be used as prefixes.

Generally, these will be integer types.

Note that this is separate to binary representation, so endianness is irrelevant.

TODO oops can't use Ints everywhere because of overflow :'( that's OK

Associated Types

type Max a :: Natural

Methods

lenToPfx :: Int -> a

used by put. guaranteed that it fits from refined. that is, lenToPfx <= Max.

pfxToLen :: a -> Int

used by get. better not lie.

Instances

Prefix Word16

Defined in Binrep.Type.Prefix

Associated Types

type Max Word16 :: Natural

Methods

lenToPfx :: Int -> Word16

pfxToLen :: Word16 -> Int

Prefix Word32

Defined in Binrep.Type.Prefix

Associated Types

type Max Word32 :: Natural

Methods

lenToPfx :: Int -> Word32

pfxToLen :: Word32 -> Int

Prefix Word8

Defined in Binrep.Type.Prefix

Associated Types

type Max Word8 :: Natural

Methods

lenToPfx :: Int -> Word8

pfxToLen :: Word8 -> Int

Prefix ()

Length prefixing with the unit means a length of 0.

This is the only sensible case. 1 doesn't work because refining checks <=.

I think there are laws here, where using this is the same as doing nothing at all.

Defined in Binrep.Type.Prefix

Associated Types

type Max () :: Natural

Methods

lenToPfx :: Int -> ()

pfxToLen :: () -> Int

Prefix a => Prefix (Endian end a)

Defined in Binrep.Type.Prefix

Associated Types

type Max (Endian end a) :: Natural

Methods

lenToPfx :: Int -> Endian end a

pfxToLen :: Endian end a -> Int