Data.Type.BitRecords.Core

Bit-Records

Bit-Record Type

data BitRecord where

BitRecordFields assembly

Constructors

EmptyBitRecord :: BitRecord

BitRecordMember :: IsA (BitRecordField t) -> BitRecord

BitRecordAppend :: BitRecord -> BitRecord -> BitRecord

Instances

BitStringBuilderHoley (Proxy (Eval r)) a => BitStringBuilderHoley (Proxy r) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy r) a :: Type

Methods

bitStringBuilderHoley :: Proxy r -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy r) a)

BitStringBuilderHoley (Proxy EmptyBitRecord) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy EmptyBitRecord) a :: Type

Methods

bitStringBuilderHoley :: Proxy EmptyBitRecord -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy EmptyBitRecord) a)

BitStringBuilderHoley (Proxy f) a => BitStringBuilderHoley (Proxy (BitRecordMember f)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (BitRecordMember f)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (BitRecordMember f) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (BitRecordMember f)) a)

(BitStringBuilderHoley (Proxy l) (ToBitStringBuilder (Proxy r) a), BitStringBuilderHoley (Proxy r) a) => BitStringBuilderHoley (Proxy (BitRecordAppend l r)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (BitRecordAppend l r)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (BitRecordAppend l r) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (BitRecordAppend l r)) a)

type ToPretty (rec :: BitRecord)

Defined in Data.Type.BitRecords.Core

type ToPretty (rec :: BitRecord) = PrettyRecord rec

type SizeFieldValue (b :: BitRecord)

Defined in Data.Type.BitRecords.Sized

type SizeFieldValue (b :: BitRecord) = BitRecordMemberCount b

type (BitRecordAppendFun_ l :: A (BitRecord :-> BitRecord) -> Type) $~ (r :: BitRecord)

Defined in Data.Type.BitRecords.Core

type (BitRecordAppendFun_ l :: A (BitRecord :-> BitRecord) -> Type) $~ (r :: BitRecord) = Append l r

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

Defined in Data.Type.BitRecords.Core

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

type Eval (OptionalRecord (Just t) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

type Eval (StaticExpandableContent record :: A BitRecord -> Type)

Defined in Data.ByteString.Mp4.Boxes.Expandable

type Eval (StaticExpandableContent record :: A BitRecord -> Type) = ExpandableSize (ShiftR StaticExpandableContentMaxBits (BitRecordSize record) 3) :+: record

type Eval (RecArray r n :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

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

Defined in Data.Type.BitRecords.Core

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

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

Defined in Data.Type.BitRecords.Core

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

type (BitRecordOfDescriptor :: A (Descriptor tag :-> BitRecord) -> Type) $~ (MkDescriptor body :: Descriptor tag)

Defined in Data.ByteString.Mp4.Boxes.BaseDescriptor

type (BitRecordOfDescriptor :: A (Descriptor tag :-> BitRecord) -> Type) $~ (MkDescriptor body :: Descriptor tag) = (FieldU8 := tagInd) .+: Eval (StaticExpandableContent body)

type Eval (BitRecordOfList f xs :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

type Eval (Sized sf r :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Sized

type Eval (Sized sf r :: A BitRecord -> Type) = (("size" @: sf) := SizeFieldValue r) .+: r

type Eval (RecordField f :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

type Eval (MaybeField (Nothing :: Maybe (IsA (BitRecordField t))) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type Eval (MaybeField (Nothing :: Maybe (IsA (BitRecordField t))) :: A BitRecord -> Type) = EmptyBitRecord

type Eval (MaybeField (Just fld) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

type Eval (SizedField sf r :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Sized

type Eval (SizedField sf r :: A BitRecord -> Type) = (("size" @: sf) := SizeFieldValue r) .+. r

type ToBitStringBuilder (Proxy r) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy r) a = ToBitStringBuilder (Proxy (Eval r)) a

type ToBitStringBuilder (Proxy EmptyBitRecord) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy EmptyBitRecord) a = a

type ToBitStringBuilder (Proxy (BitRecordMember f)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (BitRecordMember f)) a = ToBitStringBuilder (Proxy f) a

type ToBitStringBuilder (Proxy (BitRecordAppend l r)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (BitRecordAppend l r)) a = ToBitStringBuilder (Proxy l) (ToBitStringBuilder (Proxy r) a)

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 BitRecordSize (x :: BitRecord) :: Nat where ...

Get the number of bits in a BitRecord

Equations

BitRecordSize EmptyBitRecord = 0

BitRecordSize (BitRecordMember f) = BitRecordFieldSize f

BitRecordSize (BitRecordAppend l r) = BitRecordSize l + BitRecordSize r

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 (BitRecordAppend l r) = BitRecordMemberCount l + BitRecordMemberCount r

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

Get the size of the record.

type OptionalRecordOf (f :: IsA (s :-> IsA BitRecord)) (x :: Maybe s) = (Optional (Pure EmptyBitRecord) f $~ x :: IsA BitRecord)

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

Record composition

data (l :: BitRecord) :+^ (r :: IsA BitRecord) :: IsA 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 Eval (l :+^ r :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

data (l :: IsA BitRecord) :^+ (r :: BitRecord) :: IsA 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 Eval (l :^+ r :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type Eval (l :^+ r :: A BitRecord -> Type) = Append (Eval 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 :: IsA (BitRecordField t1)) = Append r (BitRecordMember f) infixl 6

Append a BitRecord and a BitRecordField

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

Append a BitRecordField and a BitRecord

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

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

type family (field :: IsA (BitRecordField (t :: BitField (rt :: Type) (st :: k) (len :: Nat)))) :~ (value :: IsA (FieldValue (label :: Symbol) st)) :: IsA (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 :: IsA (BitRecordField (t :: BitField (rt :: Type) (st :: k) (len :: Nat)))) :~? (value :: Maybe (IsA (FieldValue (label :: Symbol) st))) :: IsA 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 = Pure EmptyBitRecord

type family (fld :: IsA (BitRecordField (t :: BitField (rt :: Type) (st :: k) (len :: Nat)))) :+? (value :: Maybe (IsA (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 -> IsA (FieldValue label staticRep)

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

Record Arrays and Repitition

data RecArray :: BitRecord -> Nat -> IsA 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 Eval (RecArray r n :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type Eval (RecArray r n :: A 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 :: IsA (foo :-> BitRecord)) (xs :: [foo]) :: IsA BitRecord

Let type level lists also be records

Instances

type Eval (BitRecordOfList f xs :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

type BitRecordAppendFun = Fun1 BitRecordAppendFun_

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

Instances

type (BitRecordAppendFun_ l :: A (BitRecord :-> BitRecord) -> Type) $~ (r :: BitRecord)

Defined in Data.Type.BitRecords.Core

type (BitRecordAppendFun_ l :: A (BitRecord :-> BitRecord) -> Type) $~ (r :: BitRecord) = Append l r

Maybe Record

data OptionalRecord :: Maybe BitRecord -> IsA BitRecord

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

Instances

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

Defined in Data.Type.BitRecords.Core

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

type Eval (OptionalRecord (Just t) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type Eval (OptionalRecord (Just t) :: A 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

BitStringBuilderHoley (Proxy (MkField MkFieldFlag)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldFlag) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI8)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI16)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI32)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI64)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU8)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU8) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU8)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU16)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU16) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU16)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU32)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU32) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU32)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU64)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU64) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU64)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (rt -> a), Num rt) => BitStringBuilderHoley (Proxy (f := v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := v)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (x -> a), Num x) => BitStringBuilderHoley (Proxy (f := NegativeNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := NegativeNat v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := NegativeNat v)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (x -> a), Num x) => BitStringBuilderHoley (Proxy (f := PositiveNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := PositiveNat v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := PositiveNat v)) a)

BitRecordFieldSize f ~ 1 => BitStringBuilderHoley (Proxy (f := False)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := False)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := False) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := False)) a)

BitRecordFieldSize f ~ 1 => BitStringBuilderHoley (Proxy (f := True)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := True)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := True) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := True)) a)

BitStringBuilderHoley (Proxy nested) a => BitStringBuilderHoley (Proxy (LabelF l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (LabelF l nested)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (LabelF l nested) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (LabelF l nested)) a)

KnownChunkSize s => BitStringBuilderHoley (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldBits)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldBits)) a)

KnownChunkSize size => BitStringBuilderHoley (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size))) r

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldCustom)) r :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldCustom) -> FunctionBuilder BitStringBuilder r (ToBitStringBuilder (Proxy (MkField MkFieldCustom)) r)

(KnownNat (FromEnum e v), KnownChunkSize size) => BitStringBuilderHoley (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToBitStringBuilder (Proxy (f := v)) r :: Type

Methods

bitStringBuilderHoley :: Proxy (f := v) -> FunctionBuilder BitStringBuilder r (ToBitStringBuilder (Proxy (f := v)) r)

type Eval (MaybeField (Nothing :: Maybe (IsA (BitRecordField t))) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type Eval (MaybeField (Nothing :: Maybe (IsA (BitRecordField t))) :: A BitRecord -> Type) = EmptyBitRecord

type Eval (MaybeField (Just fld) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

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

Defined in Data.Type.BitRecords.Core

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

type ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a = Bool -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a = Int8 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a = Int16 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a = Int32 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a = Int64 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU8)) a = Word8 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU16)) a = Word16 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU32)) a = Word32 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU64)) a = Word64 -> a

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a = a

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a = a

type ToBitStringBuilder (Proxy (f := v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := v)) a = a

type ToBitStringBuilder (Proxy (f := False)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := False)) a = a

type ToBitStringBuilder (Proxy (f := True)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := True)) a = a

type ToBitStringBuilder (Proxy (LabelF l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (LabelF l nested)) a = ToBitStringBuilder (Proxy nested) a

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

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

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

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

Defined in Data.Type.BitRecords.Enum

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

type ToBitStringBuilder (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Enum

type ToBitStringBuilder (Proxy (f := v)) r = r

type SizeFieldValue (MkField t :: A (BitRecordField t) -> Type)

Defined in Data.Type.BitRecords.Sized

type SizeFieldValue (MkField t :: A (BitRecordField t) -> Type) = size

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

Defined in Data.Type.BitRecords.Sized

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

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

Defined in Data.Type.BitRecords.Sized

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

data MkField t :: IsA (BitRecordField t)

A bit record field with a number of bits

Instances

BitStringBuilderHoley (Proxy (MkField MkFieldFlag)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldFlag) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI8)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI16)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI32)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI64)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU8)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU8) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU8)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU16)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU16) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU16)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU32)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU32) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU32)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldU64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldU64)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldU64) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldU64)) a)

KnownChunkSize s => BitStringBuilderHoley (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldBits)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldBits)) a)

KnownChunkSize size => BitStringBuilderHoley (Proxy (MkField (MkFieldCustom :: BitField (EnumValue e) e size))) r

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldCustom)) r :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldCustom) -> FunctionBuilder BitStringBuilder r (ToBitStringBuilder (Proxy (MkField MkFieldCustom)) r)

type ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldFlag)) a = Bool -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a = Int8 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a = Int16 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a = Int32 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a = Int64 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU8)) a = Word8 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU16)) a = Word16 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU32)) a = Word32 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldU64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldU64)) a = Word64 -> a

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

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

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

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

Defined in Data.Type.BitRecords.Enum

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

type SizeFieldValue (MkField t :: A (BitRecordField t) -> Type)

Defined in Data.Type.BitRecords.Sized

type SizeFieldValue (MkField t :: A (BitRecordField t) -> Type) = size

Setting a Label

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

A bit record field with a number of bits

Instances

BitStringBuilderHoley (Proxy nested) a => BitStringBuilderHoley (Proxy (LabelF l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (LabelF l nested)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (LabelF l nested) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (LabelF l nested)) a)

type ToBitStringBuilder (Proxy (LabelF l nested)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (LabelF l nested)) a = ToBitStringBuilder (Proxy nested) a

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

Defined in Data.Type.BitRecords.Sized

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

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

A field with a label assigned to it.

Assignment

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

A field with a value set at compile time.

Instances

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (rt -> a), Num rt) => BitStringBuilderHoley (Proxy (f := v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := v)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (x -> a), Num x) => BitStringBuilderHoley (Proxy (f := NegativeNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := NegativeNat v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := NegativeNat v)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (x -> a), Num x) => BitStringBuilderHoley (Proxy (f := PositiveNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := PositiveNat v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := PositiveNat v)) a)

BitRecordFieldSize f ~ 1 => BitStringBuilderHoley (Proxy (f := False)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := False)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := False) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := False)) a)

BitRecordFieldSize f ~ 1 => BitStringBuilderHoley (Proxy (f := True)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := True)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := True) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := True)) a)

(KnownNat (FromEnum e v), KnownChunkSize size) => BitStringBuilderHoley (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Enum

Associated Types

type ToBitStringBuilder (Proxy (f := v)) r :: Type

Methods

bitStringBuilderHoley :: Proxy (f := v) -> FunctionBuilder BitStringBuilder r (ToBitStringBuilder (Proxy (f := v)) r)

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a = a

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a = a

type ToBitStringBuilder (Proxy (f := v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := v)) a = a

type ToBitStringBuilder (Proxy (f := False)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := False)) a = a

type ToBitStringBuilder (Proxy (f := True)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := True)) a = a

type ToBitStringBuilder (Proxy (f := v)) r

Defined in Data.Type.BitRecords.Enum

type ToBitStringBuilder (Proxy (f := v)) r = r

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

Defined in Data.Type.BitRecords.Sized

type SizeFieldValue (f := v :: A (BitRecordField t) -> Type) = SizeFieldValue 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

type Flag = MkField MkFieldFlag

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

type FieldU8 = MkField MkFieldU8

type FieldU16 = MkField MkFieldU16

type FieldU32 = MkField 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

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

KnownChunkSize s => BitStringBuilderHoley (Proxy (MkField (MkFieldBits :: BitField (B s) Nat s))) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldBits)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldBits) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldBits)) a)

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

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (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

BitStringBuilderHoley (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI8) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI8)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI16) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI16)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI32) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI32)) a)

BitStringBuilderHoley (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (MkField MkFieldI64) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (MkField MkFieldI64)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (x -> a), Num x) => BitStringBuilderHoley (Proxy (f := NegativeNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := NegativeNat v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := NegativeNat v)) a)

(KnownNat v, BitStringBuilderHoley (Proxy f) a, ToBitStringBuilder (Proxy f) a ~ (x -> a), Num x) => BitStringBuilderHoley (Proxy (f := PositiveNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

Associated Types

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a :: Type

Methods

bitStringBuilderHoley :: Proxy (f := PositiveNat v) -> FunctionBuilder BitStringBuilder a (ToBitStringBuilder (Proxy (f := PositiveNat v)) a)

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI8)) a = Int8 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI16)) a = Int16 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI32)) a = Int32 -> a

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (MkField MkFieldI64)) a = Int64 -> a

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := NegativeNat v)) a = a

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a

Defined in Data.Type.BitRecords.Builder.LazyByteStringBuilder

type ToBitStringBuilder (Proxy (f := PositiveNat v)) a = a

Composed Fields

type family FlagJust (a :: Maybe (v :: Type)) :: IsA (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)) :: IsA (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 (IsA (BitRecordField t)) -> IsA BitRecord

An optional field in a bit record

Instances

type Eval (MaybeField (Nothing :: Maybe (IsA (BitRecordField t))) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

type Eval (MaybeField (Nothing :: Maybe (IsA (BitRecordField t))) :: A BitRecord -> Type) = EmptyBitRecord

type Eval (MaybeField (Just fld) :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

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

A BitRecordField can be used as BitRecordMember

Instances

type Eval (RecordField f :: A BitRecord -> Type)

Defined in Data.Type.BitRecords.Core

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

type family BitRecordFieldSize (x :: IsA (BitRecordField t)) where ...

Calculate the size as a number of bits from a BitRecordField

Equations

BitRecordFieldSize (x :: IsA (BitRecordField (t :: BitField rt st size))) = size

Field and Record PrettyType Instances

showARecord :: forall proxy (rec :: IsA BitRecord). PrettyTypeShow (PrettyRecord (Eval 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 EmptyBitRecord = PrettyNewline

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

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

Equations

PrettyField (MkField t) = PrettyFieldType t

PrettyField ((f :: IsA (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))