Moduleserdoc-core-0.3.2.0Haskell2010

Data.SerDoc.Info

13 types
10 values

Packageserdoc-core-0.3.2.0
Exports23
LanguageHaskell2010
LicenceApache-2.0
SourceInfo.hs

Documentation annotation types

1 declaration

newtypenewtype Description

Used to add descriptions via ANN pragmas. This is necessary because Template Haskell cannot find Haddock comments attached to constructors inside associated types, but it can find annotations on those same constructors.

Constructors

Description
- descriptionParagraphs :: [String]

Instances7Eq, Data, Read, Show, Semigroup, Monoid, …

Eq DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Data DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Read DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Semigroup DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Monoid DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Lift DescriptionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

FieldInfo and related types

19 declarations

datadata FieldInfo codec

Describes the serialization format of a field.

Constructors

AnnField !String !(FieldInfo codec)
Adds an annotation to a field.
BasicField !BasicFieldInfo
A simple field, with a named type and a size.
EnumField !EnumFieldInfo
An enum field, which reports labels and values for the possible values.
CompoundField !(CompoundFieldInfo codec)
A field that is composed out of multiple sub-fields, encoded sequentially.
ChoiceField !(ChoiceFieldInfo codec)
A list of alternatives, to be picked based on a given choice condition.
ListField !(ListFieldInfo codec)
A list of values, encoded sequentially. The length must be encoded separately, and can be referenced from a length expression.
AliasField !(AliasFieldInfo codec)
Adds an alternative name (alias) to a field type.
SumField !(SumFieldInfo codec)
A list of named alternatives. TODO: this is probably redundant and may not actually work.

Instances2Eq, Show

Eq (FieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (FieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata BasicFieldInfo

Constructors

BasicFieldInfo
- basicFieldType :: !String
- basicFieldSize :: !FieldSize

Instances2Eq, Show

Eq BasicFieldInfoDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show BasicFieldInfoDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata EnumFieldInfo

Constructors

EnumFieldInfo
- enumFieldType :: !String
- enumFieldSize :: !FieldSize
- enumFieldValues :: ![(Int, String)]

Instances2Eq, Show

Eq EnumFieldInfoDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show EnumFieldInfoDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata AliasFieldInfo codec

Constructors

AliasFieldInfo
- aliasFieldName :: !String
- aliasFieldTarget :: !FieldInfo codec

Instances2Eq, Show

Eq (AliasFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (AliasFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata CompoundFieldInfo codec

Constructors

CompoundFieldInfo
- compoundFieldType :: !String
- compoundFieldSubfields :: ![SubfieldInfo codec]

Instances2Eq, Show

Eq (CompoundFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (CompoundFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata SumFieldInfo codec

Constructors

SumFieldInfo
- sumFieldType :: !String
- sumFieldAlternatives :: ![(String, FieldInfo codec)]

Instances2Eq, Show

Eq (SumFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (SumFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata ListFieldInfo codec

Constructors

ListFieldInfo
- listSize :: !FieldSize
- listElemInfo :: !FieldInfo codec

Instances2Eq, Show

Eq (ListFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (ListFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata SubfieldInfo codec

Constructors

SubfieldInfo
- subfieldName :: !String
- subfieldInfo :: !FieldInfo codec

Instances2Eq, Show

Eq (SubfieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (SubfieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata ChoiceCondition

Constructors

IndexField !String
IndexFlag !String Word32

Instances2Eq, Show

Eq ChoiceConditionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show ChoiceConditionDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

datadata ChoiceFieldInfo codec

Constructors

ChoiceFieldInfo
- choiceCondition :: !ChoiceCondition
- choiceFieldAlternatives :: ![FieldInfo codec]

Instances2Eq, Show

Eq (ChoiceFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show (ChoiceFieldInfo codec)Defined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

valueannField :: String -> FieldInfo codec -> FieldInfo codec

valuebasicField :: String -> FieldSize -> FieldInfo codec

valueenumField :: String -> FieldSize -> [(Int, String)] -> FieldInfo codec

valueenumField_ :: String -> [String] -> FieldInfo codec

valuealiasField :: String -> FieldInfo codec -> FieldInfo codec

valuecompoundField :: String -> [(String, FieldInfo codec)] -> FieldInfo codec

valuechoiceField :: ChoiceCondition -> [FieldInfo codec] -> FieldInfo codec

valuesumField :: String -> [(String, FieldInfo codec)] -> FieldInfo codec

valuelistField :: FieldSize -> FieldInfo codec -> FieldInfo codec

Field sizes

3 declarations

datadata FieldSize

Constructors

FixedSize !Int
Exactly this size
EnumSize
The default enum size for the codec
VarSize !String
Size given by a named variable from the context
BinopSize !FieldSizeBinop !FieldSize !FieldSize
Binary operation
RangeSize !FieldSize !FieldSize
Min/max range
UnknownSize
Size is entirely unknown

Instances2Eq, Show

Eq FieldSizeDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show FieldSizeDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info

valueknownSize :: FieldSize -> Maybe Int

datadata FieldSizeBinop

FSPlus FSMul FSMax FSMin

Instances2Eq, Show

Eq FieldSizeBinopDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info
Show FieldSizeBinopDefined in serdoc-core-0.3.2.0 · Data.SerDoc.Info