Data.Aeson.Schema.Type

Defines SchemaType, the AST that defines a JSON schema.

Documentation

data Schema' s ty

The schema definition for a JSON object.

Constructors

Schema (SchemaObjectMap' s ty)

Instances

(Eq s, Eq ty) => Eq (Schema' s ty)

Defined in Data.Aeson.Schema.Type

Methods

(==) :: Schema' s ty -> Schema' s ty -> Bool

(/=) :: Schema' s ty -> Schema' s ty -> Bool

(Show s, Show ty) => Show (Schema' s ty)

Defined in Data.Aeson.Schema.Type

Methods

showsPrec :: Int -> Schema' s ty -> ShowS

show :: Schema' s ty -> String

showList :: [Schema' s ty] -> ShowS

IsSchemaObjectMap (FromSchema schema) => IsSchemaType ('SchemaInclude ('Right schema :: Either Type Schema))

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaInclude ('Right schema)) -> SchemaTypeV

IsSchema schema => HasSchemaResult ('SchemaInclude ('Right schema :: Either Type Schema))

Defined in Data.Aeson.Schema.Internal

Methods

parseValue :: [Text] -> Value -> Parser (SchemaResult ('SchemaInclude ('Right schema)))

toValue :: SchemaResult ('SchemaInclude ('Right schema)) -> Value

showValue :: SchemaResult ('SchemaInclude ('Right schema)) -> ShowS

data SchemaType' s ty

The AST defining a JSON schema.

Constructors

SchemaScalar ty

SchemaMaybe (SchemaType' s ty)

SchemaTry (SchemaType' s ty)

@since v1.2.0

SchemaList (SchemaType' s ty)

SchemaUnion [SchemaType' s ty]

@since v1.1.0

SchemaObject (SchemaObjectMap' s ty)

SchemaInclude (Either ty (Schema' s ty))

An optimization for including schemas.

Will always be Left when used in a value-level schema and Right when used in a type-level schema. We can't use a type parameter for this because type synonyms can't be recursive (e.g. `type Schema = Schema' Symbol Type Schema`).

@since v1.3.2

Instances

ParseSumType ('[] :: [SchemaType])

Defined in Data.Aeson.Schema.Internal

Methods

parseSumType :: [Text] -> Value -> Parser (SumType (SchemaResultList '[]))

(Eq ty, Eq s) => Eq (SchemaType' s ty)

Defined in Data.Aeson.Schema.Type

Methods

(==) :: SchemaType' s ty -> SchemaType' s ty -> Bool

(/=) :: SchemaType' s ty -> SchemaType' s ty -> Bool

(Show ty, Show s) => Show (SchemaType' s ty)

Defined in Data.Aeson.Schema.Type

Methods

showsPrec :: Int -> SchemaType' s ty -> ShowS

show :: SchemaType' s ty -> String

showList :: [SchemaType' s ty] -> ShowS

(HasSchemaResult schema, ParseSumType schemas) => ParseSumType (schema ': schemas)

Defined in Data.Aeson.Schema.Internal

Methods

parseSumType :: [Text] -> Value -> Parser (SumType (SchemaResultList (schema ': schemas)))

(IsSchemaKey key, HasSchemaResult inner, Typeable (SchemaResult inner)) => HasSchemaResultPair '(key, inner)

Defined in Data.Aeson.Schema.Internal

Methods

parseValuePair :: Proxy '(key, inner) -> [Text] -> Object -> Parser (Text, Dynamic)

toValuePair :: forall (schema :: Schema). Proxy '(key, inner) -> Object schema -> Object

showValuePair :: forall (schema :: Schema). Proxy '(key, inner) -> Object schema -> (String, ShowS)

type SchemaV = Schema' String NameLike

type SchemaTypeV = SchemaType' String NameLike

type SchemaObjectMapV = SchemaObjectMap' String NameLike

toSchemaObjectV :: SchemaV -> SchemaTypeV

fromSchemaV :: SchemaV -> SchemaObjectMapV

showSchemaV :: SchemaV -> String

Show the given schema, as "{ key: Schema, ... }"

showSchemaTypeV :: SchemaTypeV -> String

Pretty show the given SchemaType.

type Schema = Schema' Symbol Type

The kind of schemas that may be used with Object; e.g.

data Payload (schema :: Schema) = Payload
  { getPayload :: Object schema
  , timestamp  :: UTCTime
  }

type SchemaType = SchemaType' Symbol Type

type family ToSchemaObject (schema :: Schema) :: SchemaType where ...

Equations

ToSchemaObject ('Schema schema) = 'SchemaObject schema

type family FromSchema (schema :: Schema) :: SchemaObjectMap where ...

Equations

FromSchema ('Schema schema) = schema

class IsSchemaType (schemaType :: SchemaType) where

Methods

toSchemaTypeV :: Proxy schemaType -> SchemaTypeV

Instances

Typeable inner => IsSchemaType ('SchemaScalar inner :: SchemaType' Symbol Type)

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaScalar inner) -> SchemaTypeV

IsSchemaType inner => IsSchemaType ('SchemaMaybe inner)

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaMaybe inner) -> SchemaTypeV

IsSchemaType inner => IsSchemaType ('SchemaTry inner)

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaTry inner) -> SchemaTypeV

IsSchemaType inner => IsSchemaType ('SchemaList inner)

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaList inner) -> SchemaTypeV

All IsSchemaType schemas => IsSchemaType ('SchemaUnion schemas)

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaUnion schemas) -> SchemaTypeV

IsSchemaObjectMap pairs => IsSchemaType ('SchemaObject pairs)

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaObject pairs) -> SchemaTypeV

IsSchemaObjectMap (FromSchema schema) => IsSchemaType ('SchemaInclude ('Right schema :: Either Type Schema))

Defined in Data.Aeson.Schema.Type

Methods

toSchemaTypeV :: Proxy ('SchemaInclude ('Right schema)) -> SchemaTypeV

type IsSchemaObjectMap (pairs :: SchemaObjectMap) = All IsSchemaObjectPair pairs

toSchemaV :: forall schema. IsSchemaObjectMap (FromSchema schema) => Proxy schema -> SchemaV