| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.Type.BitRecords.Enum
Synopsis
- data EnumOf enum where
- type BitRecordOfEnum (e :: IsAn (EnumOf enum)) = (RenderEnumOf (Eval e) :: BitRecord)
- type family RenderEnumOf (e :: EnumOf enum) :: BitRecord where ...
- data EnumField (enum :: Type) (size :: Nat)
- type BitRecordFieldOfEnumField (x :: IsA (EnumField e s)) = MkField (MkFieldCustom :: BitField (EnumValue e) e s)
- data FixedEnum (enum :: Type) (size :: Nat) :: IsAn (EnumField enum size)
- data ExtEnum (enum :: Type) (size :: Nat) (extInd :: enum) (extField :: IsA (BitRecordField (t :: BitField rt0 (st0 :: k0) len0))) :: IsAn (EnumField enum size)
- data SetEnum (l :: Symbol) (ef :: IsAn (EnumField enum size)) (v :: enum) :: IsAn (EnumOf enum)
- data EnumParam (label :: Symbol) (ef :: IsAn (EnumField (enum :: Type) (size :: Nat))) :: IsAn (EnumOf enum)
- data SetEnumAlt (l :: Symbol) (ef :: IsAn (EnumField (enum :: Type) (size :: Nat))) (v :: k) :: IsAn (EnumOf enum)
- data EnumParamAlt (label :: Symbol) (ef :: IsAn (EnumField (enum :: Type) (size :: Nat))) :: IsAn (EnumOf enum)
- type family FromEnum enum (entry :: enum) :: Nat
- data EnumValue e where
- MkEnumValue :: KnownNat (FromEnum e v) => Proxy (v :: e) -> EnumValue e
- enumValueProxy :: KnownNat (FromEnum e v) => Proxy (v :: e) -> EnumValue e
- fromEnumValue :: EnumValue e -> Word64
BitRecordFields containing enum-like types
data EnumOf enum where Source #
Wrapper around a type that can be represented as a short number, indexing the clauses of the (sum) type.
Constructors
| MkEnumOf :: IsAn (EnumField enum size) -> IsA (FieldValue label enum) -> BitRecord -> EnumOf enum |
Instances
| type Eval (EnumParam label ei :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (EnumParam label ei :: A (EnumOf enum) -> Type) = MkEnumOf ei (RuntimeFieldValue label :: A (FieldValue label enum) -> Type) EmptyBitRecord | |
| type Eval (EnumParamAlt label (FixedEnum enum size) :: A (EnumOf enum) -> Type) Source # | |
| type Eval (EnumParamAlt label (ExtEnum enum size extInd extField) :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (EnumParamAlt label (ExtEnum enum size extInd extField) :: A (EnumOf enum) -> Type) = MkEnumOf (ExtEnum enum size extInd extField) (StaticFieldValue label extInd) (BitRecordMember (extField :~ (RuntimeFieldValue label :: A (FieldValue label st) -> Type))) | |
| type Eval (SetEnum l ei value :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (SetEnum l ei value :: A (EnumOf enum) -> Type) = MkEnumOf ei (StaticFieldValue l value) EmptyBitRecord | |
| type Eval (SetEnumAlt l (FixedEnum enum size) value :: A (EnumOf enum) -> Type) Source # | |
| type Eval (SetEnumAlt l (ExtEnum enum size extInd extField) value :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (SetEnumAlt l (ExtEnum enum size extInd extField) value :: A (EnumOf enum) -> Type) = MkEnumOf (ExtEnum enum size extInd extField) (StaticFieldValue l extInd) (BitRecordMember (extField := value)) | |
type BitRecordOfEnum (e :: IsAn (EnumOf enum)) = (RenderEnumOf (Eval e) :: BitRecord) Source #
type family RenderEnumOf (e :: EnumOf enum) :: BitRecord where ... Source #
Equations
| RenderEnumOf (MkEnumOf mainField mainFieldVal extra) = (BitRecordFieldOfEnumField mainField :~ mainFieldVal) .+: extra |
data EnumField (enum :: Type) (size :: Nat) Source #
Physical representation of an EnumOf, this is an abstract type
type BitRecordFieldOfEnumField (x :: IsA (EnumField e s)) = MkField (MkFieldCustom :: BitField (EnumValue e) e s) Source #
data FixedEnum (enum :: Type) (size :: Nat) :: IsAn (EnumField enum size) Source #
A fixed size EnumField
data ExtEnum (enum :: Type) (size :: Nat) (extInd :: enum) (extField :: IsA (BitRecordField (t :: BitField rt0 (st0 :: k0) len0))) :: IsAn (EnumField enum size) Source #
An enum that can be extended with an additional BitRecordField, following
the regular enum field; the extension is optional, i.e. only if the
regular field contains a special value (e.g. 0xff).
Instances
| type Eval (EnumParamAlt label (ExtEnum enum size extInd extField) :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (EnumParamAlt label (ExtEnum enum size extInd extField) :: A (EnumOf enum) -> Type) = MkEnumOf (ExtEnum enum size extInd extField) (StaticFieldValue label extInd) (BitRecordMember (extField :~ (RuntimeFieldValue label :: A (FieldValue label st) -> Type))) | |
| type Eval (SetEnumAlt l (ExtEnum enum size extInd extField) value :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (SetEnumAlt l (ExtEnum enum size extInd extField) value :: A (EnumOf enum) -> Type) = MkEnumOf (ExtEnum enum size extInd extField) (StaticFieldValue l extInd) (BitRecordMember (extField := value)) | |
data SetEnum (l :: Symbol) (ef :: IsAn (EnumField enum size)) (v :: enum) :: IsAn (EnumOf enum) Source #
Create an EnumOf that sets an enum to a static value.
data EnumParam (label :: Symbol) (ef :: IsAn (EnumField (enum :: Type) (size :: Nat))) :: IsAn (EnumOf enum) Source #
Create an EnumOf that sets the enum to a runtime value.
Instances
| type Eval (EnumParam label ei :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (EnumParam label ei :: A (EnumOf enum) -> Type) = MkEnumOf ei (RuntimeFieldValue label :: A (FieldValue label enum) -> Type) EmptyBitRecord | |
data SetEnumAlt (l :: Symbol) (ef :: IsAn (EnumField (enum :: Type) (size :: Nat))) (v :: k) :: IsAn (EnumOf enum) Source #
Create an EnumOf that sets an extended enum to an extended static value.
Instances
| type Eval (SetEnumAlt l (FixedEnum enum size) value :: A (EnumOf enum) -> Type) Source # | |
| type Eval (SetEnumAlt l (ExtEnum enum size extInd extField) value :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (SetEnumAlt l (ExtEnum enum size extInd extField) value :: A (EnumOf enum) -> Type) = MkEnumOf (ExtEnum enum size extInd extField) (StaticFieldValue l extInd) (BitRecordMember (extField := value)) | |
data EnumParamAlt (label :: Symbol) (ef :: IsAn (EnumField (enum :: Type) (size :: Nat))) :: IsAn (EnumOf enum) Source #
Create an EnumOf that sets the extended enum to a runtime value.
Instances
| type Eval (EnumParamAlt label (FixedEnum enum size) :: A (EnumOf enum) -> Type) Source # | |
| type Eval (EnumParamAlt label (ExtEnum enum size extInd extField) :: A (EnumOf enum) -> Type) Source # | |
Defined in Data.Type.BitRecords.Enum type Eval (EnumParamAlt label (ExtEnum enum size extInd extField) :: A (EnumOf enum) -> Type) = MkEnumOf (ExtEnum enum size extInd extField) (StaticFieldValue label extInd) (BitRecordMember (extField :~ (RuntimeFieldValue label :: A (FieldValue label st) -> Type))) | |
Composing BitRecords with enum fields
type family FromEnum enum (entry :: enum) :: Nat Source #
Return the numeric index of an entry in a table. This emulates fromEnum a bit.
Instances
data EnumValue e where Source #
An enum value supplied at runtime.
Constructors
| MkEnumValue :: KnownNat (FromEnum e v) => Proxy (v :: e) -> EnumValue e |
Instances
fromEnumValue :: EnumValue e -> Word64 Source #