Binrep.Type.Prefix.Internal

Documentation

class LenNat a where

Types which can encode natural (positive integer) lengths.

Types must provide convert to and from Int, which is the most common type used for data lengths.

Associated Types

type LenNatMax a :: Natural

The maximum value the type can encode.

type LenNatName a :: Symbol

The name of the type, to display when used as part of a predicate.

Methods

lenToNat :: Int -> a

Turn an Int length into an a.

It is guaranteed that the Int fits i.e. <= LenNatMax a.

natToLen :: a -> Int

Turn an a into an Int length.

Don't worry if a may encode larger numbers than Int. I think other things will be breaking at that point. Or perhaps it's our responsibility to emit the runtime error? TODO.

Instances

LenNat Word16

Defined in Binrep.Type.Prefix.Internal

Associated Types

type LenNatMax Word16

Defined in Binrep.Type.Prefix.Internal

type LenNatMax Word16 = (2 ^ 16) - 1

type LenNatName Word16

Defined in Binrep.Type.Prefix.Internal

type LenNatName Word16 = "Word16"

Methods

lenToNat :: Int -> Word16

natToLen :: Word16 -> Int

LenNat Word32

Defined in Binrep.Type.Prefix.Internal

Associated Types

type LenNatMax Word32

Defined in Binrep.Type.Prefix.Internal

type LenNatMax Word32 = (2 ^ 32) - 1

type LenNatName Word32

Defined in Binrep.Type.Prefix.Internal

type LenNatName Word32 = "Word32"

Methods

lenToNat :: Int -> Word32

natToLen :: Word32 -> Int

LenNat Word64

Defined in Binrep.Type.Prefix.Internal

Associated Types

type LenNatMax Word64

Defined in Binrep.Type.Prefix.Internal

type LenNatMax Word64 = (2 ^ 64) - 1

type LenNatName Word64

Defined in Binrep.Type.Prefix.Internal

type LenNatName Word64 = "Word64"

Methods

lenToNat :: Int -> Word64

natToLen :: Word64 -> Int

LenNat Word8

Defined in Binrep.Type.Prefix.Internal

Associated Types

type LenNatMax Word8

Defined in Binrep.Type.Prefix.Internal

type LenNatMax Word8 = (2 ^ 8) - 1

type LenNatName Word8

Defined in Binrep.Type.Prefix.Internal

type LenNatName Word8 = "Word8"

Methods

lenToNat :: Int -> Word8

natToLen :: Word8 -> Int

LenNat ()

The unit can only encode 1 value -> lengths of 0 only.

Defined in Binrep.Type.Prefix.Internal

Associated Types

type LenNatMax ()

Defined in Binrep.Type.Prefix.Internal

type LenNatMax () = 0

type LenNatName ()

Defined in Binrep.Type.Prefix.Internal

type LenNatName () = "()"

Methods

lenToNat :: Int -> ()

natToLen :: () -> Int

LenNat a => LenNat (ByteOrdered end a)

Defined in Binrep.Type.Prefix.Internal

Associated Types

type LenNatMax (ByteOrdered end a)

Byte ordering doesn't change how prefixes work.

Defined in Binrep.Type.Prefix.Internal

type LenNatMax (ByteOrdered end a) = LenNatMax a

type LenNatName (ByteOrdered end a)

Defined in Binrep.Type.Prefix.Internal

type LenNatName (ByteOrdered end a) = LenNatName a

Methods

lenToNat :: Int -> ByteOrdered end a

natToLen :: ByteOrdered end a -> Int