Mu.GraphQL.Annotations

GraphQL schemas may contain some information which cannot be directly represented in a Mu schema or service definition. The types in this module can be used with the annotation mechanism in Mu to provide this additional information.

Documentation

data ValueConst nat symbol

Type-level GraphQL constant values. Due to limitations in type-level literal values floating point constants cannot be represented.

Constructors

VCInt nat

Integer.

VCString symbol

String.

VCBoolean Bool

Boolean.

VCNull

Null.

VCEnum symbol

Enumeration value.

VCList [ValueConst nat symbol]

List of constant values.

VCObject [(symbol, ValueConst nat symbol)]

Object represented by (key, value) tuples.

newtype DefaultValue

Specifies the default value of an argument. To be used as an annotation.

Constructors

DefaultValue (ValueConst Nat Symbol)

class ReflectValueConst (v :: ValueConst nat symbol) where

Obtain the GraphQL constant corresponding to a type-level constant. Inhabited by any ValueConst, but still required to please the type checker.

Methods

reflectValueConst :: proxy v -> ConstValue

Obtain the GraphQL constant corresponding to a type-level constant.

Instances

ReflectValueConst ('VCNull :: ValueConst nat symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy 'VCNull -> ConstValue

KnownNat n => ReflectValueConst ('VCInt n :: ValueConst Nat symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCInt n) -> ConstValue

KnownSymbol e => ReflectValueConst ('VCEnum e :: ValueConst nat Symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCEnum e) -> ConstValue

ReflectValueConst ('VCBoolean 'False :: ValueConst nat symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCBoolean 'False) -> ConstValue

ReflectValueConst ('VCBoolean 'True :: ValueConst nat symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCBoolean 'True) -> ConstValue

KnownSymbol s => ReflectValueConst ('VCString s :: ValueConst nat Symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCString s) -> ConstValue

ReflectValueConstList xs => ReflectValueConst ('VCList xs :: ValueConst nat symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCList xs) -> ConstValue

ReflectValueConstObject xs => ReflectValueConst ('VCObject xs :: ValueConst nat symbol)

Defined in Mu.GraphQL.Annotations

Methods

reflectValueConst :: proxy ('VCObject xs) -> ConstValue

fromGQLValueConst :: forall f. Alternative f => ConstValue -> f (ValueConst Integer String)

Turn a ValueConst coming from parsing in the annotation data type. Mostly used internally to generate Mu schemas from GraphQL schemas.