Safe Haskell	None
Language	Haskell2010

RON.Schema

Synopsis

data Alias stage = Alias {
- name :: Text
- target :: UseType stage
}
data CaseTransform = TitleCase
data Declaration stage
- = DAlias (Alias stage)
- | DEnum TEnum
- | DOpaque Opaque
- | DStructLww (StructLww stage)
- | DStructSet (StructSet stage)
data Field (stage :: Stage) = Field {
- ronType :: UseType stage
- annotations :: FieldAnnotations
- ext :: XField stage
}
type family XField (stage :: Stage)
newtype FieldAnnotations = FieldAnnotations {
- mergeStrategy :: Maybe MergeStrategy
}
defaultFieldAnnotations :: FieldAnnotations
data MergeStrategy
- = LWW
- | Max
- | Min
- | Set
data Opaque = Opaque {
- isObject :: Bool
- name :: Text
- annotations :: OpaqueAnnotations
}
opaqueAtoms :: Text -> OpaqueAnnotations -> RonType
opaqueAtoms_ :: Text -> RonType
opaqueObject :: Text -> OpaqueAnnotations -> RonType
newtype OpaqueAnnotations = OpaqueAnnotations {
- haskellType :: Maybe Text
}
defaultOpaqueAnnotations :: OpaqueAnnotations
data RonType
- = TAtom TAtom
- | TComposite TComposite
- | TObject TObject
- | TOpaque Opaque
type family Schema (stage :: Stage) where ...
data Stage
- = Parsed
- | Resolved
- | Equipped
data Struct (encoding :: StructEncoding) stage = Struct {
- name :: Text
- fields :: Map Text (Field stage)
- annotations :: StructAnnotations
}
data StructAnnotations = StructAnnotations {
- haskellFieldPrefix :: Text
- haskellFieldCaseTransform :: Maybe CaseTransform
}
defaultStructAnnotations :: StructAnnotations
data StructEncoding
- = SELww
- | SESet
type StructLww = Struct SELww
type StructSet = Struct SESet
data TAtom
- = TAFloat
- | TAInteger
- | TAString
- | TAUuid
newtype TComposite = TEnum TEnum
data TEnum = Enum {
- name :: Text
- items :: [Text]
}
data TObject
- = TORSet RonType
- | TORSetMap RonType RonType
- | TRga RonType
- | TStructLww (StructLww Resolved)
- | TStructSet (StructSet Resolved)
- | TVersionVector
data TypeExpr
- = Use TypeName
- | Apply TypeName [TypeExpr]
type TypeName = Text
type family UseType (stage :: Stage) where ...

Documentation

data Alias stage Source #

Constructors

Alias
Fields name :: Text target :: UseType stage

Instances

Show (UseType stage) => Show (Alias stage) Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> Alias stage -> ShowS # show :: Alias stage -> String # showList :: [Alias stage] -> ShowS #
FromEDN (Alias Parsed) Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser (Alias Parsed) # parseEDNv :: Value -> Parser (Alias Parsed) #

data CaseTransform Source #

Constructors

TitleCase

Instances

Show CaseTransform Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> CaseTransform -> ShowS # show :: CaseTransform -> String # showList :: [CaseTransform] -> ShowS #
FromEDN CaseTransform Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser CaseTransform # parseEDNv :: Value -> Parser CaseTransform #

data Declaration stage Source #

Constructors

DAlias (Alias stage)
DEnum TEnum
DOpaque Opaque
DStructLww (StructLww stage)
DStructSet (StructSet stage)

Instances

(Show (UseType stage), Show (XField stage)) => Show (Declaration stage) Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> Declaration stage -> ShowS # show :: Declaration stage -> String # showList :: [Declaration stage] -> ShowS #
FromEDN (Declaration Parsed) Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser (Declaration Parsed) # parseEDNv :: Value -> Parser (Declaration Parsed) #

data Field (stage :: Stage) Source #

Constructors

Field
Fields ronType :: UseType stage annotations :: FieldAnnotations ext :: XField stage

Instances

(Show (UseType stage), Show (XField stage)) => Show (Field stage) Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> Field stage -> ShowS # show :: Field stage -> String # showList :: [Field stage] -> ShowS #

type family XField (stage :: Stage) Source #

Instances

type XField Parsed Source #
Instance details Defined in RON.Schema type XField Parsed = ()
type XField Resolved Source #
Instance details Defined in RON.Schema type XField Resolved = ()
type XField Equipped Source #
Instance details Defined in RON.Schema.TH.Struct type XField Equipped

newtype FieldAnnotations Source #

Constructors

FieldAnnotations
Fields mergeStrategy :: Maybe MergeStrategy

Instances

Show FieldAnnotations Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> FieldAnnotations -> ShowS # show :: FieldAnnotations -> String # showList :: [FieldAnnotations] -> ShowS #
FromEDN FieldAnnotations Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser FieldAnnotations # parseEDNv :: Value -> Parser FieldAnnotations #

defaultFieldAnnotations :: FieldAnnotations Source #

data MergeStrategy Source #

Constructors

LWW
Max
Min
Set

Instances

Show MergeStrategy Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> MergeStrategy -> ShowS # show :: MergeStrategy -> String # showList :: [MergeStrategy] -> ShowS #
FromEDN MergeStrategy Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser MergeStrategy # parseEDNv :: Value -> Parser MergeStrategy #

data Opaque Source #

Constructors

Opaque
Fields isObject :: Bool name :: Text annotations :: OpaqueAnnotations

Instances

Show Opaque Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> Opaque -> ShowS # show :: Opaque -> String # showList :: [Opaque] -> ShowS #
FromEDN Opaque Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser Opaque # parseEDNv :: Value -> Parser Opaque #

opaqueAtoms :: Text -> OpaqueAnnotations -> RonType Source #

opaqueAtoms_ :: Text -> RonType Source #

opaqueObject :: Text -> OpaqueAnnotations -> RonType Source #

newtype OpaqueAnnotations Source #

Constructors

OpaqueAnnotations
Fields haskellType :: Maybe Text

Instances

Show OpaqueAnnotations Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> OpaqueAnnotations -> ShowS # show :: OpaqueAnnotations -> String # showList :: [OpaqueAnnotations] -> ShowS #

defaultOpaqueAnnotations :: OpaqueAnnotations Source #

data RonType Source #

Constructors

TAtom TAtom
TComposite TComposite
TObject TObject
TOpaque Opaque

Instances

Show RonType Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> RonType -> ShowS # show :: RonType -> String # showList :: [RonType] -> ShowS #

type family Schema (stage :: Stage) where ... Source #

Equations

Schema Parsed = [Declaration Parsed]
Schema Resolved = Map TypeName (Declaration Resolved)

data Stage Source #

Constructors

Parsed
Resolved
Equipped

data Struct (encoding :: StructEncoding) stage Source #

Constructors

Struct
Fields name :: Text fields :: Map Text (Field stage) annotations :: StructAnnotations

Instances

FromEDN (StructSet Parsed) Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser (StructSet Parsed) # parseEDNv :: Value -> Parser (StructSet Parsed) #
FromEDN (StructLww Parsed) Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser (StructLww Parsed) # parseEDNv :: Value -> Parser (StructLww Parsed) #
(Show (UseType stage), Show (XField stage)) => Show (Struct encoding stage) Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> Struct encoding stage -> ShowS # show :: Struct encoding stage -> String # showList :: [Struct encoding stage] -> ShowS #

data StructAnnotations Source #

Constructors

StructAnnotations
Fields haskellFieldPrefix :: Text haskellFieldCaseTransform :: Maybe CaseTransform

Instances

Show StructAnnotations Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> StructAnnotations -> ShowS # show :: StructAnnotations -> String # showList :: [StructAnnotations] -> ShowS #
FromEDN StructAnnotations Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser StructAnnotations # parseEDNv :: Value -> Parser StructAnnotations #

defaultStructAnnotations :: StructAnnotations Source #

data StructEncoding Source #

Constructors

SELww
SESet

type StructLww = Struct SELww Source #

type StructSet = Struct SESet Source #

data TAtom Source #

Constructors

TAFloat
TAInteger
TAString
TAUuid

Instances

Show TAtom Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> TAtom -> ShowS # show :: TAtom -> String # showList :: [TAtom] -> ShowS #

newtype TComposite Source #

TODO(2019-08-04, cblp) do we need is as a group?

Constructors

TEnum TEnum

Instances

Show TComposite Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> TComposite -> ShowS # show :: TComposite -> String # showList :: [TComposite] -> ShowS #

data TEnum Source #

Constructors

Enum
Fields name :: Text items :: [Text]

Instances

Show TEnum Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> TEnum -> ShowS # show :: TEnum -> String # showList :: [TEnum] -> ShowS #
FromEDN TEnum Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser TEnum # parseEDNv :: Value -> Parser TEnum #

data TObject Source #

Constructors

TORSet RonType
TORSetMap RonType RonType
TRga RonType
TStructLww (StructLww Resolved)
TStructSet (StructSet Resolved)
TVersionVector

Instances

Show TObject Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> TObject -> ShowS # show :: TObject -> String # showList :: [TObject] -> ShowS #

data TypeExpr Source #

Constructors

Use TypeName
Apply TypeName [TypeExpr]

Instances

Show TypeExpr Source #
Instance details Defined in RON.Schema Methods showsPrec :: Int -> TypeExpr -> ShowS # show :: TypeExpr -> String # showList :: [TypeExpr] -> ShowS #
FromEDN TypeExpr Source #
Instance details Defined in RON.Schema.EDN Methods parseEDN :: TaggedValue -> Parser TypeExpr # parseEDNv :: Value -> Parser TypeExpr #

type TypeName = Text Source #

type family UseType (stage :: Stage) where ... Source #

Equations

UseType Parsed = TypeExpr
UseType Resolved = RonType
UseType Equipped = RonType