Binrep.Type.NullPadded

Documentation

data NullPad (n :: Natural)

Instances

(BLen a, KnownNat n) => Predicate (NullPad n :: Type) a

Defined in Binrep.Type.NullPadded

Methods

validate :: Proxy (NullPad n) -> a -> Maybe RefineException

(BLen a, Get a, KnownNat n) => Get (NullPadded n a)

Defined in Binrep.Type.NullPadded

Methods

get :: Getter (NullPadded n a)

(BLen a, Put a, KnownNat n) => Put (NullPadded n a)

Defined in Binrep.Type.NullPadded

Methods

put :: NullPadded n a -> Poke

type NullPadded n a = Refined (NullPad n) a

A type which is to be null-padded to a given total length.

Given some a :: NullPadded n a, it is guaranteed that

blen a <= natValInt @n

thus

natValInt @n - blen a >= 0

That is, the serialized stored data will not be longer than the total length.

The binrep instances are careful not to construct bytestrings unnecessarily.