Binrep.ByteLen

Documentation

class ByteLen a where

The size in bytes of the type can be known, preferably on the cheap e.g. reading a length field.

Aim to make this O(1). Except for where you can't like lists lol.

Importantly goes hand in hand with BinaryCodec! Maybe we should make it a function there lol!

This is useful for padding types generically, without having to track the read/write cursor. Yes, that feature *is* common and cheap for parsers (and to lesser extent, serializers), but you should really only be padding types that have a "static-ish" (= cheaply calculated) size. At least, I think so? I'm not quite sure.

Some instances ignore the argument. It would be possible to pull those out into a statically-known bytelength typeclass, but it wouldn't improve clarity or performance, just get rid of a couple undefineds.

Methods

blen :: a -> Natural

Instances

ByteLen (Str 'C)

Defined in Binrep.Types.Strings

Methods

blen :: Str 'C -> Natural

ByteLen (I 'U size e) => ByteLen (Str ('Pascal size e))

Defined in Binrep.Types.Strings

Methods

blen :: Str ('Pascal size e) -> Natural

ByteLen a => ByteLen [a]

Defined in Binrep.ByteLen

Methods

blen :: [a] -> Natural

ByteLen (I s 'I1 e)

Defined in Binrep.Types.Ints

Methods

blen :: I s 'I1 e -> Natural

ByteLen (I s 'I2 e)

Defined in Binrep.Types.Ints

Methods

blen :: I s 'I2 e -> Natural

ByteLen (I s 'I4 e)

Defined in Binrep.Types.Ints

Methods

blen :: I s 'I4 e -> Natural

ByteLen (I s 'I8 e)

Defined in Binrep.Types.Ints

Methods

blen :: I s 'I8 e -> Natural

(ByteLen a, itype ~ I 'U size e, ByteLen itype) => ByteLen (WithRefine 'Enforced (LenPfx size e) a)

TODO why safe

Defined in Binrep.Types.Strings

Methods

blen :: WithRefine 'Enforced (LenPfx size e) a -> Natural

KnownNat n => ByteLen (WithRefine 'Enforced (NullPadTo n) a)

Defined in Binrep.Predicates.NullPadTo

Methods

blen :: WithRefine 'Enforced (NullPadTo n) a -> Natural