Maintainer	Brandon Chinn <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Aeson.Schema.Type

Description

Defines SchemaType, the AST that defines a JSON schema.

Synopsis

Documentation

The schema definition for a JSON object.

Constructors

Schema (SchemaObjectMap' s ty)

Instances details

(Show s, Show ty) => Show (Schema' s ty) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods showsPrec :: Int -> Schema' s ty -> ShowS # show :: Schema' s ty -> String # showList :: [Schema' s ty] -> ShowS #
(Eq s, Eq ty) => Eq (Schema' s ty) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods (==) :: Schema' s ty -> Schema' s ty -> Bool # (/=) :: Schema' s ty -> Schema' s ty -> Bool #
IsSchema schema => HasSchemaResult ('SchemaInclude ('Right schema :: Either Type Schema)) Source #
Instance details Defined in Data.Aeson.Schema.Internal Methods parseValue :: [Key] -> Value -> Parser (SchemaResult ('SchemaInclude ('Right schema))) Source # toValue :: SchemaResult ('SchemaInclude ('Right schema)) -> Value Source # showValue :: SchemaResult ('SchemaInclude ('Right schema)) -> ShowS Source #
IsSchemaObjectMap (FromSchema schema) => IsSchemaType ('SchemaInclude ('Right schema :: Either Type Schema)) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaInclude ('Right schema)) -> SchemaTypeV Source #

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 details

ParseSumType ('[] :: [SchemaType]) Source #
Instance details Defined in Data.Aeson.Schema.Internal Methods parseSumType :: [Key] -> Value -> Parser (SumType (SchemaResultList '[])) Source #
(Show ty, Show s) => Show (SchemaType' s ty) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods showsPrec :: Int -> SchemaType' s ty -> ShowS # show :: SchemaType' s ty -> String # showList :: [SchemaType' s ty] -> ShowS #
(Eq ty, Eq s) => Eq (SchemaType' s ty) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods (==) :: SchemaType' s ty -> SchemaType' s ty -> Bool # (/=) :: SchemaType' s ty -> SchemaType' s ty -> Bool #
(HasSchemaResult schema, ParseSumType schemas) => ParseSumType (schema ': schemas) Source #
Instance details Defined in Data.Aeson.Schema.Internal Methods parseSumType :: [Key] -> Value -> Parser (SumType (SchemaResultList (schema ': schemas))) Source #
(IsSchemaKey key, HasSchemaResult inner, Typeable (SchemaResult inner)) => HasSchemaResultPair '(key, inner) Source #
Instance details Defined in Data.Aeson.Schema.Internal Methods parseValuePair :: Proxy '(key, inner) -> [Key] -> Object -> Parser (Key, Dynamic) Source # toValuePair :: forall (schema :: Schema). Proxy '(key, inner) -> Object schema -> Object Source # showValuePair :: forall (schema :: Schema). Proxy '(key, inner) -> Object schema -> (String, ShowS) Source #

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

Pretty show the given SchemaType.

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

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

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

Equations

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

Equations

FromSchema ('Schema schema) = schema

class IsSchemaType (schemaType :: SchemaType) where Source #

Methods

Instances details

IsSchemaObjectMap (FromSchema schema) => IsSchemaType ('SchemaInclude ('Right schema :: Either Type Schema)) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaInclude ('Right schema)) -> SchemaTypeV Source #
IsSchemaType inner => IsSchemaType ('SchemaList inner) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaList inner) -> SchemaTypeV Source #
IsSchemaType inner => IsSchemaType ('SchemaMaybe inner) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaMaybe inner) -> SchemaTypeV Source #
IsSchemaObjectMap pairs => IsSchemaType ('SchemaObject pairs) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaObject pairs) -> SchemaTypeV Source #
Typeable inner => IsSchemaType ('SchemaScalar inner :: SchemaType' Symbol Type) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaScalar inner) -> SchemaTypeV Source #
IsSchemaType inner => IsSchemaType ('SchemaTry inner) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaTry inner) -> SchemaTypeV Source #
All IsSchemaType schemas => IsSchemaType ('SchemaUnion schemas) Source #
Instance details Defined in Data.Aeson.Schema.Type Methods toSchemaTypeV :: Proxy ('SchemaUnion schemas) -> SchemaTypeV Source #

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