Data.Aeson.Schema.Key

Defines a SchemaKey.

Documentation

data SchemaKey' s

A key in a JSON object schema.

Constructors

NormalKey s

PhantomKey s

A key that doesn't actually exist in the object, but whose content should be parsed from the current object.

Instances

Generic (SchemaKey' s)

Defined in Data.Aeson.Schema.Key

Associated Types

type Rep (SchemaKey' s) :: Type -> Type

Methods

from :: SchemaKey' s -> Rep (SchemaKey' s) x

to :: Rep (SchemaKey' s) x -> SchemaKey' s

Show s => Show (SchemaKey' s)

Defined in Data.Aeson.Schema.Key

Methods

showsPrec :: Int -> SchemaKey' s -> ShowS

show :: SchemaKey' s -> String

showList :: [SchemaKey' s] -> ShowS

Eq s => Eq (SchemaKey' s)

Defined in Data.Aeson.Schema.Key

Methods

(==) :: SchemaKey' s -> SchemaKey' s -> Bool

(/=) :: SchemaKey' s -> SchemaKey' s -> Bool

Hashable s => Hashable (SchemaKey' s)

Defined in Data.Aeson.Schema.Key

Methods

hashWithSalt :: Int -> SchemaKey' s -> Int

hash :: SchemaKey' s -> Int

Lift s => Lift (SchemaKey' s :: Type)

Defined in Data.Aeson.Schema.Key

Methods

lift :: Quote m => SchemaKey' s -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => SchemaKey' s -> Code m (SchemaKey' s)

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

Defined in Data.Aeson.Schema.Internal

Methods

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

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

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

type Rep (SchemaKey' s)

Defined in Data.Aeson.Schema.Key

type Rep (SchemaKey' s) = D1 ('MetaData "SchemaKey'" "Data.Aeson.Schema.Key" "aeson-schemas-1.4.0.0-JqG7TL2i0UW92I4msZOA7P" 'False) (C1 ('MetaCons "NormalKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 s)) :+: C1 ('MetaCons "PhantomKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 s)))

type SchemaKeyV = SchemaKey' String

A value-level SchemaKey

fromSchemaKeyV :: SchemaKeyV -> String

showSchemaKeyV :: SchemaKeyV -> String

getContext :: SchemaKeyV -> Object -> Value

Given schema `{ key: innerSchema }` for JSON data `{ key: val1 }`, get the JSON Value that innerSchema should parse.

toContext :: SchemaKeyV -> Value -> Object

Given JSON data val adhering to innerSchema, get the JSON object that should be merged with the outer JSON object.

type SchemaKey = SchemaKey' Symbol

A type-level SchemaKey

class KnownSymbol (FromSchemaKey key) => IsSchemaKey (key :: SchemaKey) where

Associated Types

type FromSchemaKey key :: Symbol

Methods

toSchemaKeyV :: Proxy key -> SchemaKeyV

Instances

KnownSymbol key => IsSchemaKey ('NormalKey key)

Defined in Data.Aeson.Schema.Key

Associated Types

type FromSchemaKey ('NormalKey key) :: Symbol

Methods

toSchemaKeyV :: Proxy ('NormalKey key) -> SchemaKeyV

KnownSymbol key => IsSchemaKey ('PhantomKey key)

Defined in Data.Aeson.Schema.Key

Associated Types

type FromSchemaKey ('PhantomKey key) :: Symbol

Methods

toSchemaKeyV :: Proxy ('PhantomKey key) -> SchemaKeyV

fromSchemaKey :: forall key. IsSchemaKey key => String

showSchemaKey :: forall key. IsSchemaKey key => String