Data.Type.BitRecords.Core

NamedStructure definition for sequences of bits.

This module provides the core data types and functions for conversion of finite bit sequences from an to conventional (Haskell) data types.

Non-compressed, non-random finite bit sequences generated by programs are usually compositions of bytes and multi byte words, and a ton of Haskell libraries exist for the serialization and deserialization of ByteStrings.

This module allows the definition of a structure i.e. a very simple grammar, which allows functions in this library to read and write single bytes, words and bits.

Also complete bit sequence may be constructed or destructed from and to Haskell types.

Further more, the structures may contain dependent sub-sequences, for example to express structures that precede a length field before a repetitive block data.

Antother example for dependent sequences is fields whose presence depends on flags preceding them.

This library is also designed with zero copying in mind.

It should be emphasized that binary deserialization is not to be confused with binary destructuring. While the former usually involves copying all regular sub sequences from the input to a value of a certain type, the later merely requires to peek into the sequeuence at a certain position and deserializing a sub sequence. The starting position and the interpretation are governed by the strucuture applied to the sequence.

Bit-Records

Bit-Record Type

data BitRecord where

BitRecordFields assembly

Constructors

EmptyBitRecord :: BitRecord

BitRecordMember :: Extends (BitRecordField t) -> BitRecord

RecordField :: Extends (BitField rt st size) -> BitRecord

BitRecordAppend :: BitRecord -> BitRecord -> BitRecord

Instances

HasFunctionBuilder BitBuilder (Proxy (From r)) => HasFunctionBuilder BitBuilder (Proxy r)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy r) r :: Type

Methods

toFunctionBuilder :: Proxy r -> FunctionBuilder BitBuilder r0 (ToFunction BitBuilder (Proxy r) r0)

HasFunctionBuilder BitBuilder (Proxy EmptyBitRecord)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy EmptyBitRecord) r :: Type

Methods

toFunctionBuilder :: Proxy EmptyBitRecord -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy EmptyBitRecord) r)

HasFunctionBuilder BitBuilder (Proxy f) => HasFunctionBuilder BitBuilder (Proxy (BitRecordMember f))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (BitRecordMember f)) r :: Type

Methods

toFunctionBuilder :: Proxy (BitRecordMember f) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (BitRecordMember f)) r)

HasFunctionBuilder BitBuilder (Proxy f) => HasFunctionBuilder BitBuilder (Proxy (RecordField f))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (RecordField f)) r :: Type

Methods

toFunctionBuilder :: Proxy (RecordField f) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (RecordField f)) r)

(HasFunctionBuilder BitBuilder (Proxy l), HasFunctionBuilder BitBuilder (Proxy r)) => HasFunctionBuilder BitBuilder (Proxy (BitRecordAppend l r))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (BitRecordAppend l r)) r :: Type

Methods

toFunctionBuilder :: Proxy (BitRecordAppend l r) -> FunctionBuilder BitBuilder r0 (ToFunction BitBuilder (Proxy (BitRecordAppend l r)) r0)

type ToPretty (rec :: BitRecord)

Defined in Data.Type.BitRecords.Core

type ToPretty (rec :: BitRecord) = PrettyRecord rec

type SizeInBytes (b :: BitRecord)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (b :: BitRecord) = Bits2Bytes (SizeInBits b)

type Apply (BitRecordAppendFun_ l :: (BitRecord -> BitRecord) -> Type) (r :: BitRecord)

Defined in Data.Type.BitRecords.Core

type Apply (BitRecordAppendFun_ l :: (BitRecord -> BitRecord) -> Type) (r :: BitRecord) = Append l r

type From (OptionalRecord (Nothing :: Maybe BitRecord))

Defined in Data.Type.BitRecords.Core

type From (OptionalRecord (Nothing :: Maybe BitRecord)) = EmptyBitRecord

type From (OptionalRecord (Just t) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (OptionalRecord (Just t) :: BitRecord -> Type) = t

type From (StaticExpandableContent record :: BitRecord -> Type)

Defined in Data.ByteString.Mp4.Boxes.Expandable

type From (StaticExpandableContent record :: BitRecord -> Type) = ExpandableSize (ShiftR StaticExpandableContentMaxBits (SizeInBits record) 3) :+: record

type From (RecArray r n :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (RecArray r n :: BitRecord -> Type) = RecArrayToBitRecord r n

type From (l :^+ r :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (l :^+ r :: BitRecord -> Type) = Append (From l) r

type From (l :+^ r :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (l :+^ r :: BitRecord -> Type) = Append l (From r)

type ToFunction BitBuilder (Proxy r) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy r) a = ToFunction BitBuilder (Proxy (From r)) a

type ToFunction BitBuilder (Proxy EmptyBitRecord) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy EmptyBitRecord) r = r

type ToFunction BitBuilder (Proxy (BitRecordMember f)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (BitRecordMember f)) a = ToFunction BitBuilder (Proxy f) a

type ToFunction BitBuilder (Proxy (RecordField f)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (RecordField f)) a = ToFunction BitBuilder (Proxy f) a

type ToFunction BitBuilder (Proxy (BitRecordAppend l r)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (BitRecordAppend l r)) a = ToFunction BitBuilder (Proxy l) (ToFunction BitBuilder (Proxy r) a)

type Apply (BitRecordOfDescriptor :: (Descriptor tag -> BitRecord) -> Type) (MkDescriptor body :: Descriptor tag)

Defined in Data.ByteString.Mp4.Boxes.BaseDescriptor

type Apply (BitRecordOfDescriptor :: (Descriptor tag -> BitRecord) -> Type) (MkDescriptor body :: Descriptor tag) = (FieldU8 := tagInd) .+: From (StaticExpandableContent body)

type From (BitRecordOfList f xs :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (BitRecordOfList f xs :: BitRecord -> Type) = FoldMap BitRecordAppendFun EmptyBitRecord f xs

type From (Sized sf r :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Sized

type From (Sized sf r :: BitRecord -> Type) = (("size" @: sf) := SizeInBytes r) .+: r

type From (RecordField f :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (RecordField f :: BitRecord -> Type) = BitRecordMember f

type From (MaybeField (Nothing :: Maybe (Extends (BitRecordField t))) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (MaybeField (Nothing :: Maybe (Extends (BitRecordField t))) :: BitRecord -> Type) = EmptyBitRecord

type From (MaybeField (Just fld) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (MaybeField (Just fld) :: BitRecord -> Type) = BitRecordMember fld

type From (SizedField sf r :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Sized

type From (SizedField sf r :: BitRecord -> Type) = (("size" @: sf) := SizeInBytes r) .+. r

type family WhenR (b :: Bool) (x :: BitRecord) :: BitRecord where ...

A conditional BitRecord

Equations

WhenR False r = EmptyBitRecord

WhenR True r = r

Basic Accessor

type family SizeInBits (x :: k) :: Nat where ...

Get the number of bits in a BitRecord

Equations

SizeInBits EmptyBitRecord = 0

SizeInBits (BitRecordMember f) = FieldWidth f

SizeInBits (RecordField f) = BitFieldSize (From f)

SizeInBits (BitRecordAppend l r) = SizeInBits l + SizeInBits r

type family SizeInBytes (c :: k) :: Nat

For something to be augmented by a size field there must be an instance of this family to generate the value of the size field, e.g. by counting the elements.

Instances

type SizeInBytes (b :: BitRecord)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (b :: BitRecord) = Bits2Bytes (SizeInBits b)

type SizeInBytes (Labelled l f :: a -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (Labelled l f :: a -> Type) = SizeInBytes f

type SizeInBytes (f :=. v :: BitField rt k size -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (f :=. v :: BitField rt k size -> Type) = SizeInBytes v

type SizeInBytes (MkField t :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (MkField t :: BitRecordField t -> Type) = SizeInBytes t

type SizeInBytes (f := v :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (f := v :: BitRecordField t -> Type) = SizeInBytes v

type SizeInBytes (LabelF l f :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (LabelF l f :: BitRecordField t -> Type) = SizeInBytes f

type SizeInBytes (t :: BitField rt st size)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (t :: BitField rt st size) = size

type Bits2Bytes (bitSize :: Nat) = Bits2Bytes2 (Div bitSize 8) (Mod bitSize 8)

type family Bits2Bytes2 (bitSizeDiv8 :: Nat) (bitSizeMod8 :: Nat) :: Nat where ...

Equations

Bits2Bytes2 bytes 0 = bytes

Bits2Bytes2 bytes n = bytes + 1

type family BitRecordMemberCount (b :: BitRecord) :: Nat where ...

Get the total number of members in a record.

Equations

BitRecordMemberCount EmptyBitRecord = 0

BitRecordMemberCount (BitRecordMember f) = 1

BitRecordMemberCount (RecordField f) = 1

BitRecordMemberCount (BitRecordAppend l r) = BitRecordMemberCount l + BitRecordMemberCount r

getRecordSizeFromProxy :: forall px (rec :: BitRecord). KnownNat (SizeInBits rec) => px rec -> Integer

Get the size of the record.

type OptionalRecordOf (f :: Extends (s -> Extends BitRecord)) (x :: Maybe s) = (Optional (Konst EmptyBitRecord) f $ x :: Extends BitRecord)

Either use the value from Just or return a EmptyBitRecord value(types(kinds))

Record composition

data (l :: BitRecord) :+^ (r :: Extends BitRecord) :: Extends BitRecord infixl 3

Combine two BitRecords to form a new BitRecord. If the parameters are not of type BitRecord they will be converted.

Instances

type From (l :+^ r :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (l :+^ r :: BitRecord -> Type) = Append l (From r)

data (l :: Extends BitRecord) :^+ (r :: BitRecord) :: Extends BitRecord infixl 3

Combine two BitRecords to form a new BitRecord. If the parameters are not of type BitRecord they will be converted.

Instances

type From (l :^+ r :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (l :^+ r :: BitRecord -> Type) = Append (From l) r

type (:+:) (l :: BitRecord) (r :: BitRecord) = (l `Append` r :: BitRecord) infixl 3

Combine two BitRecords to form a new BitRecord. If the parameters are not of type BitRecord they will be converted.

type family Append (l :: BitRecord) (r :: BitRecord) :: BitRecord where ...

Equations

Append l EmptyBitRecord = l

Append EmptyBitRecord r = r

Append l r = BitRecordAppend l r

type (:+.) (r :: BitRecord) (f :: Extends (BitRecordField t1)) = Append r (BitRecordMember f) infixl 6

Append a BitRecord and a BitRecordField

type (.+:) (f :: Extends (BitRecordField t1)) (r :: BitRecord) = Append (BitRecordMember f) r infixr 6

Append a BitRecordField and a BitRecord

type (.+.) (l :: Extends (BitRecordField t1)) (r :: Extends (BitRecordField t2)) = Append (BitRecordMember l) (BitRecordMember r) infixr 6

Append a BitRecordField and a BitRecordField forming a BitRecord with two members.

type family (field :: Extends (BitRecordField (t :: BitField (rt :: Type) (st :: k) (len :: Nat)))) :~ (value :: Extends (FieldValue (label :: Symbol) st)) :: Extends (BitRecordField t) where ... infixl 7

Set a field to either a static, compile time, value or a dynamic, runtime value.

Equations

fld :~ (StaticFieldValue l v) = (l @: fld) := v

fld :~ (RuntimeFieldValue l) = l @: fld

type family (fld :: Extends (BitRecordField (t :: BitField (rt :: Type) (st :: k) (len :: Nat)))) :~? (value :: Maybe (Extends (FieldValue (label :: Symbol) st))) :: Extends BitRecord where ... infixl 7

Like :~ but for a Maybe parameter. In case of Just it behaves like :~ in case of Nothing it return an EmptyBitRecord.

Equations

fld :~? (Just v) = RecordField (fld :~ v)

fld :~? Nothing = Konst EmptyBitRecord

type family (fld :: Extends (BitRecordField (t :: BitField (rt :: Type) (st :: k) (len :: Nat)))) :+? (value :: Maybe (Extends (FieldValue (label :: Symbol) st))) :: BitRecord where ... infixl 7

Like :~ but for a Maybe parameter. In case of Just it behaves like :~ in case of Nothing it return an EmptyBitRecord.

Equations

fld :+? (Just v) = BitRecordMember (fld :~ v)

fld :+? Nothing = EmptyBitRecord

data FieldValue :: Symbol -> staticRep -> Type

The field value parameter for :~, either a static, compile time, value or a dynamic, runtime value.

data StaticFieldValue (label :: Symbol) :: staticRep -> Extends (FieldValue label staticRep)

data RuntimeFieldValue (label :: Symbol) :: Extends (FieldValue label staticRep)

Record Arrays and Repitition

data RecArray :: BitRecord -> Nat -> Extends BitRecord

An array of records with a fixed number of elements, NOTE: this type is actually not really necessary since ReplicateRecord exists, but this allows to have a different showRecord output.

Instances

type From (RecArray r n :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (RecArray r n :: BitRecord -> Type) = RecArrayToBitRecord r n

type (^^) r n = RecArray r n infixl 5

type family RecArrayToBitRecord (r :: BitRecord) (n :: Nat) :: BitRecord where ...

Repeat a bit record n times.

Equations

RecArrayToBitRecord r 0 = EmptyBitRecord

RecArrayToBitRecord r 1 = r

RecArrayToBitRecord r n = Append r (RecArrayToBitRecord r (n - 1))

Lists of Records

data BitRecordOfList (f :: Extends (foo -> BitRecord)) (xs :: [foo]) :: Extends BitRecord

Let type level lists also be records

Instances

type From (BitRecordOfList f xs :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (BitRecordOfList f xs :: BitRecord -> Type) = FoldMap BitRecordAppendFun EmptyBitRecord f xs

type BitRecordAppendFun = Fun1 BitRecordAppendFun_

data BitRecordAppendFun_ :: BitRecord -> Extends (BitRecord -> BitRecord)

Instances

type Apply (BitRecordAppendFun_ l :: (BitRecord -> BitRecord) -> Type) (r :: BitRecord)

Defined in Data.Type.BitRecords.Core

type Apply (BitRecordAppendFun_ l :: (BitRecord -> BitRecord) -> Type) (r :: BitRecord) = Append l r

Maybe Record

data OptionalRecord :: Maybe BitRecord -> Extends BitRecord

Either use the value from Just or return a EmptyBitRecord value(types(kinds))

Instances

type From (OptionalRecord (Nothing :: Maybe BitRecord))

Defined in Data.Type.BitRecords.Core

type From (OptionalRecord (Nothing :: Maybe BitRecord)) = EmptyBitRecord

type From (OptionalRecord (Just t) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (OptionalRecord (Just t) :: BitRecord -> Type) = t

Field ADT

data BitRecordField :: BitField rt st len -> Type

A family of bit fields.

A bit field always has a size, i.e. the number of bits it uses, as well as a term level value type and a type level value type. It also has an optional label, and an optional value assigned to it.

Instances

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldFlag))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldFlag) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI8))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI8)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI16))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI16)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI32))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI32)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI64))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI64)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU8))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU8)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU8) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU8)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU16))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU16)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU16) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU16)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU32))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU32)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU32) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU32)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU64))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU64)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU64) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU64)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) rt, Num rt) => HasFunctionBuilder BitBuilder (Proxy (f := v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := v)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) x, Num x) => HasFunctionBuilder BitBuilder (Proxy (f := NegativeNat v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := NegativeNat v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := NegativeNat v)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) x, Num x) => HasFunctionBuilder BitBuilder (Proxy (f := PositiveNat v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := PositiveNat v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := PositiveNat v)) r)

FieldWidth f ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f := False))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := False)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := False) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := False)) r)

FieldWidth f ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f := True))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := True)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := True) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := True)) r)

HasFunctionBuilder BitBuilder (Proxy nested) => HasFunctionBuilder BitBuilder (Proxy (LabelF l nested))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (LabelF l nested)) r :: Type

Methods

toFunctionBuilder :: Proxy (LabelF l nested) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (LabelF l nested)) r)

KnownChunkSize s => HasFunctionBuilder BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s)))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldBits)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldBits)) r)

KnownChunkSize size => HasFunctionBuilder BitBuilder (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size)))

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldCustom)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldCustom) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldCustom)) r)

(KnownNat (FromEnum e v), KnownChunkSize size) => HasFunctionBuilder BitBuilder (Proxy (f := v))

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToFunction BitBuilder (Proxy (f := v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := v)) r)

DynamicContent BitBuilder (Proxy (MkField MkFieldI8)) Int8

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitBuilder next (Int8 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI16)) Int16

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitBuilder next (Int16 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI32)) Int32

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitBuilder next (Int32 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI64)) Int64

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitBuilder next (Int64 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU8)) Word8

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU8) -> FunctionBuilder BitBuilder next (Word8 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU16)) Word16

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU16) -> FunctionBuilder BitBuilder next (Word16 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU32)) Word32

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU32) -> FunctionBuilder BitBuilder next (Word32 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU64)) Word64

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU64) -> FunctionBuilder BitBuilder next (Word64 -> next)

DynamicContent BitBuilder (Proxy nested) b => DynamicContent BitBuilder (Proxy (LabelF l nested)) b

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (LabelF l nested) -> FunctionBuilder BitBuilder next (b -> next)

KnownChunkSize s => DynamicContent BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) (B s)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitBuilder next (B s -> next)

type ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) a = Bool -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) a = Int8 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) a = Int16 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) a = Int32 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) a = Int64 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU8)) a = Word8 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU16)) a = Word16 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU32)) a = Word32 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU64)) a = Word64 -> a

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r = r

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r = r

type ToFunction BitBuilder (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := v)) r = r

type ToFunction BitBuilder (Proxy (f := False)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := False)) r = r

type ToFunction BitBuilder (Proxy (f := True)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := True)) r = r

type ToFunction BitBuilder (Proxy (LabelF l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (LabelF l nested)) a = ToFunction BitBuilder (Proxy nested) a

type ToFunction BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a = B s -> a

type ToFunction BitBuilder (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size))) r

Defined in Data.Type.BitRecords.Enum

type ToFunction BitBuilder (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size))) r = EnumValue e -> r

type ToFunction BitBuilder (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Enum

type ToFunction BitBuilder (Proxy (f := v)) r = r

type From (MaybeField (Nothing :: Maybe (Extends (BitRecordField t))) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (MaybeField (Nothing :: Maybe (Extends (BitRecordField t))) :: BitRecord -> Type) = EmptyBitRecord

type From (MaybeField (Just fld) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (MaybeField (Just fld) :: BitRecord -> Type) = BitRecordMember fld

type ToPretty (f :: Extends (BitRecordField t))

Defined in Data.Type.BitRecords.Core

type ToPretty (f :: Extends (BitRecordField t)) = PrettyField f

type SizeInBytes (MkField t :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (MkField t :: BitRecordField t -> Type) = SizeInBytes t

type SizeInBytes (f := v :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (f := v :: BitRecordField t -> Type) = SizeInBytes v

type SizeInBytes (LabelF l f :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (LabelF l f :: BitRecordField t -> Type) = SizeInBytes f

data MkField t :: BitRecordField t -> Type

A bit record field with a number of bits

Instances

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldFlag))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldFlag) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI8))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI8)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI16))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI16)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI32))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI32)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI64))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI64)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU8))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU8)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU8) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU8)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU16))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU16)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU16) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU16)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU32))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU32)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU32) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU32)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldU64))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldU64)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldU64) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldU64)) r)

KnownChunkSize s => HasFunctionBuilder BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s)))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldBits)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldBits)) r)

KnownChunkSize size => HasFunctionBuilder BitBuilder (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size)))

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldCustom)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldCustom) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldCustom)) r)

DynamicContent BitBuilder (Proxy (MkField MkFieldI8)) Int8

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitBuilder next (Int8 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI16)) Int16

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitBuilder next (Int16 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI32)) Int32

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitBuilder next (Int32 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI64)) Int64

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitBuilder next (Int64 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU8)) Word8

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU8) -> FunctionBuilder BitBuilder next (Word8 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU16)) Word16

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU16) -> FunctionBuilder BitBuilder next (Word16 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU32)) Word32

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU32) -> FunctionBuilder BitBuilder next (Word32 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldU64)) Word64

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldU64) -> FunctionBuilder BitBuilder next (Word64 -> next)

KnownChunkSize s => DynamicContent BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) (B s)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitBuilder next (B s -> next)

type ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldFlag)) a = Bool -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) a = Int8 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) a = Int16 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) a = Int32 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) a = Int64 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU8)) a = Word8 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU16)) a = Word16 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU32)) a = Word32 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldU64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldU64)) a = Word64 -> a

type ToFunction BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a = B s -> a

type ToFunction BitBuilder (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size))) r

Defined in Data.Type.BitRecords.Enum

type ToFunction BitBuilder (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size))) r = EnumValue e -> r

type SizeInBytes (MkField t :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (MkField t :: BitRecordField t -> Type) = SizeInBytes t

Setting a Label

data LabelF :: Symbol -> Extends (BitRecordField t) -> Extends (BitRecordField t)

A bit record field with a number of bits

Instances

HasFunctionBuilder BitBuilder (Proxy nested) => HasFunctionBuilder BitBuilder (Proxy (LabelF l nested))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (LabelF l nested)) r :: Type

Methods

toFunctionBuilder :: Proxy (LabelF l nested) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (LabelF l nested)) r)

DynamicContent BitBuilder (Proxy nested) b => DynamicContent BitBuilder (Proxy (LabelF l nested)) b

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (LabelF l nested) -> FunctionBuilder BitBuilder next (b -> next)

type ToFunction BitBuilder (Proxy (LabelF l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (LabelF l nested)) a = ToFunction BitBuilder (Proxy nested) a

type SizeInBytes (LabelF l f :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (LabelF l f :: BitRecordField t -> Type) = SizeInBytes f

type (@:) (l :: Symbol) (f :: Extends (BitRecordField (t :: BitField rt (st :: stk) size))) = (LabelF l f :: Extends (BitRecordField t)) infixr 8

A field with a label assigned to it.

type (@::) (l :: Symbol) (f :: Extends a) = Labelled l f infixr 8

A field with a label assigned to it.

Assignment

data (:=) :: forall st (t :: BitField rt st size). Extends (BitRecordField t) -> st -> Extends (BitRecordField t) infixl 7

A field with a value set at compile time.

Instances

(KnownNat v, DynamicContent BitBuilder (Proxy f) rt, Num rt) => HasFunctionBuilder BitBuilder (Proxy (f := v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := v)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) x, Num x) => HasFunctionBuilder BitBuilder (Proxy (f := NegativeNat v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := NegativeNat v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := NegativeNat v)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) x, Num x) => HasFunctionBuilder BitBuilder (Proxy (f := PositiveNat v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := PositiveNat v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := PositiveNat v)) r)

FieldWidth f ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f := False))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := False)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := False) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := False)) r)

FieldWidth f ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f := True))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := True)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := True) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := True)) r)

(KnownNat (FromEnum e v), KnownChunkSize size) => HasFunctionBuilder BitBuilder (Proxy (f := v))

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToFunction BitBuilder (Proxy (f := v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := v)) r)

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r = r

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r = r

type ToFunction BitBuilder (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := v)) r = r

type ToFunction BitBuilder (Proxy (f := False)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := False)) r = r

type ToFunction BitBuilder (Proxy (f := True)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := True)) r = r

type ToFunction BitBuilder (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Enum

type ToFunction BitBuilder (Proxy (f := v)) r = r

type SizeInBytes (f := v :: BitRecordField t -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (f := v :: BitRecordField t -> Type) = SizeInBytes v

data (:=.) :: Extends (BitField rt st size) -> st -> Extends (BitField rt st size) infixl 7

A field with a value set at compile time.

Instances

(KnownNat v, DynamicContent BitBuilder (Proxy f) rt, Num rt) => HasFunctionBuilder BitBuilder (Proxy (f :=. v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f :=. v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f :=. v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f :=. v)) r)

BitFieldSize (From f) ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f :=. False))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f :=. False)) r :: Type

Methods

toFunctionBuilder :: Proxy (f :=. False) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f :=. False)) r)

BitFieldSize (From f) ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f :=. True))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f :=. True)) r :: Type

Methods

toFunctionBuilder :: Proxy (f :=. True) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f :=. True)) r)

type ToFunction BitBuilder (Proxy (f :=. v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f :=. v)) r = r

type ToFunction BitBuilder (Proxy (f :=. False)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f :=. False)) r = r

type ToFunction BitBuilder (Proxy (f :=. True)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f :=. True)) r = r

type SizeInBytes (f :=. v :: BitField rt k size -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (f :=. v :: BitField rt k size -> Type) = SizeInBytes v

data BitField (runtimeRep :: Type) (staticRep :: k) (bitCount :: Nat) where

Types of this kind define the basic type of a BitRecordField. Sure, this could have been an open type, but really, how many actual useful field types exist? Well, from a global perspective, uncountable infinite, but the focus of this library is to blast out bits over the network, using usual Haskell libraries, and hence, there is actually only very little reason to differentiate types of record fields, other than what low-level library function to apply and how to pretty print the field.

Constructors

MkFieldFlag :: BitField Bool Bool 1

MkFieldBits :: forall (n :: Nat). BitField (B n) Nat n

MkFieldBitsXXL :: forall (n :: Nat). BitField Integer Nat n

MkFieldU8 :: BitField Word8 Nat 8

MkFieldU16 :: BitField Word16 Nat 16

MkFieldU32 :: BitField Word32 Nat 32

MkFieldU64 :: BitField Word64 Nat 64

MkFieldI8 :: BitField Int8 SignedNat 8

MkFieldI16 :: BitField Int16 SignedNat 16

MkFieldI32 :: BitField Int32 SignedNat 32

MkFieldI64 :: BitField Int64 SignedNat 64

MkFieldCustom :: BitField rt st n

Instances

(KnownNat v, DynamicContent BitBuilder (Proxy f) rt, Num rt) => HasFunctionBuilder BitBuilder (Proxy (f :=. v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f :=. v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f :=. v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f :=. v)) r)

BitFieldSize (From f) ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f :=. False))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f :=. False)) r :: Type

Methods

toFunctionBuilder :: Proxy (f :=. False) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f :=. False)) r)

BitFieldSize (From f) ~ 1 => HasFunctionBuilder BitBuilder (Proxy (f :=. True))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f :=. True)) r :: Type

Methods

toFunctionBuilder :: Proxy (f :=. True) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f :=. True)) r)

HasFunctionBuilder BitBuilder (Proxy nested) => HasFunctionBuilder BitBuilder (Proxy (Labelled l nested))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (Labelled l nested)) r :: Type

Methods

toFunctionBuilder :: Proxy (Labelled l nested) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (Labelled l nested)) r)

HasFunctionBuilder BitBuilder (Proxy nested) => HasFunctionBuilder BitBuilder (Proxy (Konst nested))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (Konst nested)) r :: Type

Methods

toFunctionBuilder :: Proxy (Konst nested) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (Konst nested)) r)

HasFunctionBuilder BitBuilder (Proxy MkFieldFlag)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy MkFieldFlag) r :: Type

Methods

toFunctionBuilder :: Proxy MkFieldFlag -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy MkFieldFlag) r)

HasFunctionBuilder BitBuilder (Proxy MkFieldU32)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy MkFieldU32) r :: Type

Methods

toFunctionBuilder :: Proxy MkFieldU32 -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy MkFieldU32) r)

DynamicContent BitBuilder (Proxy nested) rt => DynamicContent BitBuilder (Proxy (Labelled l nested)) rt

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (Labelled l nested) -> FunctionBuilder BitBuilder next (rt -> next)

DynamicContent BitBuilder (Proxy nested) rt => DynamicContent BitBuilder (Proxy (Konst nested)) rt

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (Konst nested) -> FunctionBuilder BitBuilder next (rt -> next)

DynamicContent BitBuilder (Proxy MkFieldFlag) Bool

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy MkFieldFlag -> FunctionBuilder BitBuilder next (Bool -> next)

DynamicContent BitBuilder (Proxy MkFieldU32) Word32

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy MkFieldU32 -> FunctionBuilder BitBuilder next (Word32 -> next)

type ToFunction BitBuilder (Proxy (f :=. v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f :=. v)) r = r

type ToFunction BitBuilder (Proxy (f :=. False)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f :=. False)) r = r

type ToFunction BitBuilder (Proxy (f :=. True)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f :=. True)) r = r

type ToFunction BitBuilder (Proxy (Labelled l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (Labelled l nested)) a = ToFunction BitBuilder (Proxy nested) a

type ToFunction BitBuilder (Proxy (Konst nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (Konst nested)) a = ToFunction BitBuilder (Proxy nested) a

type ToFunction BitBuilder (Proxy MkFieldFlag) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy MkFieldFlag) a = Bool -> a

type ToFunction BitBuilder (Proxy MkFieldU32) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy MkFieldU32) a = Word32 -> a

type SizeInBytes (f :=. v :: BitField rt k size -> Type)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (f :=. v :: BitField rt k size -> Type) = SizeInBytes v

type SizeInBytes (t :: BitField rt st size)

Defined in Data.Type.BitRecords.Core

type SizeInBytes (t :: BitField rt st size) = size

type family BitFieldSize (b :: BitField rt st size) :: Nat where ...

Equations

BitFieldSize (b :: BitField rt st size) = size

type Flag = MkField MkFieldFlag

type Field n = MkField (MkFieldBits :: BitField (B n) Nat n)

type FieldU8 = MkField MkFieldU8

type FieldU16 = MkField MkFieldU16

type FieldU32 = Konst MkFieldU32

type FieldU64 = MkField MkFieldU64

type FieldI8 = MkField MkFieldI8

type FieldI16 = MkField MkFieldI16

type FieldI32 = MkField MkFieldI32

type FieldI64 = MkField MkFieldI64

newtype B (size :: Nat)

A data type for Field and MkFieldBits, that is internally a Word64. It carries the number of relevant bits in its type.

Constructors

B

Fields

• unB :: Word64

Instances

KnownChunkSize s => HasFunctionBuilder BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s)))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldBits)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldBits)) r)

KnownChunkSize s => DynamicContent BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) (B s)

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitBuilder next (B s -> next)

Bounded (B size)

Defined in Data.Type.BitRecords.Core

Methods

minBound :: B size

maxBound :: B size

Enum (B size)

Defined in Data.Type.BitRecords.Core

Methods

succ :: B size -> B size

pred :: B size -> B size

toEnum :: Int -> B size

fromEnum :: B size -> Int

enumFrom :: B size -> [B size]

enumFromThen :: B size -> B size -> [B size]

enumFromTo :: B size -> B size -> [B size]

enumFromThenTo :: B size -> B size -> B size -> [B size]

Eq (B size)

Defined in Data.Type.BitRecords.Core

Methods

(==) :: B size -> B size -> Bool

(/=) :: B size -> B size -> Bool

Integral (B size)

Defined in Data.Type.BitRecords.Core

Methods

quot :: B size -> B size -> B size

rem :: B size -> B size -> B size

div :: B size -> B size -> B size

mod :: B size -> B size -> B size

quotRem :: B size -> B size -> (B size, B size)

divMod :: B size -> B size -> (B size, B size)

toInteger :: B size -> Integer

Num (B size)

Defined in Data.Type.BitRecords.Core

Methods

(+) :: B size -> B size -> B size

(-) :: B size -> B size -> B size

(*) :: B size -> B size -> B size

negate :: B size -> B size

abs :: B size -> B size

signum :: B size -> B size

fromInteger :: Integer -> B size

Ord (B size)

Defined in Data.Type.BitRecords.Core

Methods

compare :: B size -> B size -> Ordering

(<) :: B size -> B size -> Bool

(<=) :: B size -> B size -> Bool

(>) :: B size -> B size -> Bool

(>=) :: B size -> B size -> Bool

max :: B size -> B size -> B size

min :: B size -> B size -> B size

Read (B size)

Defined in Data.Type.BitRecords.Core

Methods

readsPrec :: Int -> ReadS (B size)

readList :: ReadS [B size]

readPrec :: ReadPrec (B size)

readListPrec :: ReadPrec [B size]

Real (B size)

Defined in Data.Type.BitRecords.Core

Methods

toRational :: B size -> Rational

Show (B size)

Defined in Data.Type.BitRecords.Core

Methods

showsPrec :: Int -> B size -> ShowS

show :: B size -> String

showList :: [B size] -> ShowS

(PrintfArg Word64, n <= 64) => PrintfArg (B n)

Defined in Data.Type.BitRecords.Core

Methods

formatArg :: B n -> FieldFormatter

parseFormat :: B n -> ModifierParser

Bits (B size)

Defined in Data.Type.BitRecords.Core

Methods

(.&.) :: B size -> B size -> B size

(.|.) :: B size -> B size -> B size

xor :: B size -> B size -> B size

complement :: B size -> B size

shift :: B size -> Int -> B size

rotate :: B size -> Int -> B size

zeroBits :: B size

bit :: Int -> B size

setBit :: B size -> Int -> B size

clearBit :: B size -> Int -> B size

complementBit :: B size -> Int -> B size

testBit :: B size -> Int -> Bool

bitSizeMaybe :: B size -> Maybe Int

bitSize :: B size -> Int

isSigned :: B size -> Bool

shiftL :: B size -> Int -> B size

unsafeShiftL :: B size -> Int -> B size

shiftR :: B size -> Int -> B size

unsafeShiftR :: B size -> Int -> B size

rotateL :: B size -> Int -> B size

rotateR :: B size -> Int -> B size

popCount :: B size -> Int

FiniteBits (B size)

Defined in Data.Type.BitRecords.Core

Methods

finiteBitSize :: B size -> Int

countLeadingZeros :: B size -> Int

countTrailingZeros :: B size -> Int

type ToFunction BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a = B s -> a

data SignedNat where

A signed field value.

Constructors

PositiveNat :: Nat -> SignedNat

NegativeNat :: Nat -> SignedNat

Instances

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI8))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI8)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI16))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI16)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI32))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI32)) r)

HasFunctionBuilder BitBuilder (Proxy (MkField MkFieldI64))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) r :: Type

Methods

toFunctionBuilder :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (MkField MkFieldI64)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) x, Num x) => HasFunctionBuilder BitBuilder (Proxy (f := NegativeNat v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := NegativeNat v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := NegativeNat v)) r)

(KnownNat v, DynamicContent BitBuilder (Proxy f) x, Num x) => HasFunctionBuilder BitBuilder (Proxy (f := PositiveNat v))

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r :: Type

Methods

toFunctionBuilder :: Proxy (f := PositiveNat v) -> FunctionBuilder BitBuilder r (ToFunction BitBuilder (Proxy (f := PositiveNat v)) r)

DynamicContent BitBuilder (Proxy (MkField MkFieldI8)) Int8

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitBuilder next (Int8 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI16)) Int16

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitBuilder next (Int16 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI32)) Int32

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitBuilder next (Int32 -> next)

DynamicContent BitBuilder (Proxy (MkField MkFieldI64)) Int64

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Methods

addParameter :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitBuilder next (Int64 -> next)

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI8)) a = Int8 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI16)) a = Int16 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI32)) a = Int32 -> a

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (MkField MkFieldI64)) a = Int64 -> a

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := NegativeNat v)) r = r

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToFunction BitBuilder (Proxy (f := PositiveNat v)) r = r

Composed Fields

type family FlagJust (a :: Maybe (v :: Type)) :: Extends (BitRecordField MkFieldFlag) where ...

A Flag (1-bit) that is true if the type level maybe is Just.

Equations

FlagJust (Just x) = Flag := True

FlagJust Nothing = Flag := False

type family FlagNothing (a :: Maybe (v :: Type)) :: Extends (BitRecordField MkFieldFlag) where ...

A Flag (1-bit) that is true if the type level maybe is Nothing.

Equations

FlagNothing (Just x) = Flag := False

FlagNothing Nothing = Flag := True

data MaybeField :: Maybe (Extends (BitRecordField t)) -> Extends BitRecord

An optional field in a bit record

Instances

type From (MaybeField (Nothing :: Maybe (Extends (BitRecordField t))) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (MaybeField (Nothing :: Maybe (Extends (BitRecordField t))) :: BitRecord -> Type) = EmptyBitRecord

type From (MaybeField (Just fld) :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (MaybeField (Just fld) :: BitRecord -> Type) = BitRecordMember fld

data RecordField :: Extends (BitRecordField t) -> Extends BitRecord

A BitRecordField can be used as BitRecordMember

Instances

type From (RecordField f :: BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type From (RecordField f :: BitRecord -> Type) = BitRecordMember f

type family FieldWidth (x :: Extends (BitRecordField t)) where ...

Calculate the size as a number of bits from a BitRecordField

Equations

FieldWidth (x :: Extends (BitRecordField (t :: BitField rt st size))) = size

Field and Record PrettyType Instances

showARecord :: forall proxy (rec :: Extends BitRecord). PrettyTypeShow (PrettyRecord (From rec)) => proxy rec -> String

Render rec to a pretty, human readable form. Internally this is a wrapper around ptShow using PrettyRecord.

showRecord :: forall proxy (rec :: BitRecord). PrettyTypeShow (PrettyRecord rec) => proxy rec -> String

Render rec to a pretty, human readable form. Internally this is a wrapper around ptShow using PrettyRecord.

type family PrettyRecord (rec :: BitRecord) :: PrettyType where ...

Equations

PrettyRecord (BitRecordMember m) = PrettyField m

PrettyRecord (RecordField m) = PrettyRecordField m

PrettyRecord EmptyBitRecord = PrettyNewline

PrettyRecord (BitRecordAppend l r) = PrettyRecord l <$$> PrettyRecord r

type family PrettyRecordField (f :: Extends (BitField (rt :: Type) (st :: Type) (size :: Nat))) :: PrettyType where ...

Equations

PrettyRecordField (Konst t) = PrettyFieldType t

PrettyRecordField (f :=. v) = (PrettyRecordField f <+> PutStr ":=") <+> PrettyFieldValue (From f) v

PrettyRecordField (Labelled l f) = l <:> PrettyRecordField f

type family PrettyField (f :: Extends (BitRecordField (t :: BitField (rt :: Type) (st :: Type) (size :: Nat)))) :: PrettyType where ...

Equations

PrettyField (MkField t) = PrettyFieldType t

PrettyField ((f :: Extends (BitRecordField t)) := v) = (PrettyField f <+> PutStr ":=") <+> PrettyFieldValue t v

PrettyField (LabelF l f) = l <:> PrettyField f

type family PrettyFieldType (t :: BitField (rt :: Type) (st :: Type) (size :: Nat)) :: PrettyType where ...

Equations

PrettyFieldType MkFieldFlag = PutStr "boolean"

PrettyFieldType (MkFieldBits :: BitField (B (s :: Nat)) Nat s) = PutStr "bits" <++> PrettyParens (PutNat s)

PrettyFieldType (MkFieldBitsXXL :: BitField Integer Nat (s :: Nat)) = PutStr "bits-XXL" <++> PrettyParens (PutNat s)

PrettyFieldType MkFieldU64 = PutStr "U64"

PrettyFieldType MkFieldU32 = PutStr "U32"

PrettyFieldType MkFieldU16 = PutStr "U16"

PrettyFieldType MkFieldU8 = PutStr "U8"

PrettyFieldType MkFieldI64 = PutStr "I64"

PrettyFieldType MkFieldI32 = PutStr "I32"

PrettyFieldType MkFieldI16 = PutStr "I16"

PrettyFieldType MkFieldI8 = PutStr "I8"

PrettyFieldType (MkFieldCustom :: BitField rt ct size) = ToPretty rt <++> PrettyParens (PutNat size)

type family PrettyFieldValue (t :: BitField (rt :: Type) (st :: Type) (size :: Nat)) (v :: st) :: PrettyType where ...

Equations

PrettyFieldValue MkFieldFlag True = PutStr "yes"

PrettyFieldValue MkFieldFlag False = PutStr "no"

PrettyFieldValue (MkFieldBits :: BitField (B (s :: Nat)) Nat s) v = PrettyNat PrettyUnpadded (PrettyPrecision s) PrettyBit v <+> PrettyParens (("hex" <:> PutHex v) <+> ("dec" <:> PutNat v))

PrettyFieldValue MkFieldU8 v = ("hex" <:> PutHex8 v) <+> PrettyParens ("dec" <:> PutNat v)

PrettyFieldValue MkFieldU16 v = ("hex" <:> PutHex16 v) <+> PrettyParens ("dec" <:> PutNat v)

PrettyFieldValue MkFieldU32 v = ("hex" <:> PutHex32 v) <+> PrettyParens ("dec" <:> PutNat v)

PrettyFieldValue MkFieldU64 v = ("hex" <:> PutHex64 v) <+> PrettyParens ("dec" <:> PutNat v)

PrettyFieldValue MkFieldI8 (PositiveNat v) = ("hex" <:> (PutStr "+" <++> PutHex8 v)) <+> PrettyParens ("dec" <:> (PutStr "+" <++> PutNat v))

PrettyFieldValue MkFieldI16 (PositiveNat v) = ("hex" <:> (PutStr "+" <++> PutHex16 v)) <+> PrettyParens ("dec" <:> (PutStr "+" <++> PutNat v))

PrettyFieldValue MkFieldI32 (PositiveNat v) = ("hex" <:> (PutStr "+" <++> PutHex32 v)) <+> PrettyParens ("dec" <:> (PutStr "+" <++> PutNat v))

PrettyFieldValue MkFieldI64 (PositiveNat v) = ("hex" <:> (PutStr "+" <++> PutHex64 v)) <+> PrettyParens ("dec" <:> (PutStr "+" <++> PutNat v))

PrettyFieldValue MkFieldI8 (NegativeNat v) = ("hex" <:> (PutStr "-" <++> PutHex8 v)) <+> PrettyParens ("dec" <:> (PutStr "-" <++> PutNat v))

PrettyFieldValue MkFieldI16 (NegativeNat v) = ("hex" <:> (PutStr "-" <++> PutHex16 v)) <+> PrettyParens ("dec" <:> (PutStr "-" <++> PutNat v))

PrettyFieldValue MkFieldI32 (NegativeNat v) = ("hex" <:> (PutStr "-" <++> PutHex32 v)) <+> PrettyParens ("dec" <:> (PutStr "-" <++> PutNat v))

PrettyFieldValue MkFieldI64 (NegativeNat v) = ("hex" <:> (PutStr "-" <++> PutHex64 v)) <+> PrettyParens ("dec" <:> (PutStr "-" <++> PutNat v))

PrettyFieldValue (MkFieldCustom :: BitField rt ct size) v = PrettyCustomFieldValue rt ct size v

type family PrettyCustomFieldValue (rt :: Type) (st :: Type) (size :: Nat) (v :: st) :: PrettyType

Instances

type PrettyCustomFieldValue ASizedString ASizedString s (sr :: ASizedString)

Defined in Data.Type.BitRecords.SizedString

type PrettyCustomFieldValue ASizedString ASizedString s (sr :: ASizedString) = ToPretty sr

type PrettyCustomFieldValue (EnumValue e) e size (v :: e)

Defined in Data.Type.BitRecords.Enum

type PrettyCustomFieldValue (EnumValue e) e size (v :: e) = (PutNat (FromEnum e v) <+> ("hex" <:> PutHex (FromEnum e v))) <+> ("bin" <:> PutBits (FromEnum e v))

type family PrintHexIfPossible t (s :: Nat) :: PrettyType where ...

Equations

PrintHexIfPossible Word64 s = PutHex64 s

PrintHexIfPossible Word32 s = PutHex32 s

PrintHexIfPossible Word16 s = PutHex16 s

PrintHexIfPossible Word8 s = PutHex8 s

PrintHexIfPossible x s = TypeError (Text "Invalid size field type: " :<>: ShowType x)