Data.Registry.Aeson.Encoder

Documentation

data FromConstructor

Minimum set of data extracted from a given type with Template Haskell in order to create the appropriate encoder given an Options value

Constructors

FromConstructor

Fields

• fromConstructorNames :: [Text]

  names of all the constructors of the type

• fromConstructorTypes :: [Text]

  types of all the constructors of the type

• fromConstructorName :: Text

  name of the constructor for the value to encode

• fromConstructorFieldNames :: [Text]

  name of all the constructor fields

• fromConstructorValues :: [(Value, Encoding)]

  encoded values of all the constructor fields

Instances

Show FromConstructor

Defined in Data.Registry.Aeson.Encoder

Methods

showsPrec :: Int -> FromConstructor -> ShowS

show :: FromConstructor -> String

showList :: [FromConstructor] -> ShowS

Eq FromConstructor

Defined in Data.Registry.Aeson.Encoder

Methods

(==) :: FromConstructor -> FromConstructor -> Bool

(/=) :: FromConstructor -> FromConstructor -> Bool

newtype ConstructorEncoder

A ConstructorEncoder uses configuration options + type information extracted from a given data type (with TemplateHaskell) in order to produce a Value and an Encoding

Constructors

ConstructorEncoder

Fields

• encodeConstructor :: Options -> FromConstructor -> (Value, Encoding)

newtype KeyEncoder a

Constructors

KeyEncoder

Fields

• encodeAsKey :: a -> Key

Instances

Contravariant KeyEncoder

Defined in Data.Registry.Aeson.Encoder

Methods

contramap :: (a' -> a) -> KeyEncoder a -> KeyEncoder a'

(>$) :: b -> KeyEncoder b -> KeyEncoder a

newtype Encoder a

Constructors

Encoder

Fields

• encode :: a -> (Value, Encoding)

Instances

Contravariant Encoder

Defined in Data.Registry.Aeson.Encoder

Methods

contramap :: (a' -> a) -> Encoder a -> Encoder a'

(>$) :: b -> Encoder b -> Encoder a

encodeByteString :: Encoder a -> a -> ByteString

encodeValue :: Encoder a -> a -> Value

encodeKey :: forall a. Typeable a => (a -> Text) -> Typed (KeyEncoder a)

Make a key encoder from a function returning some text

keyEncoder :: (a -> Text) -> KeyEncoder a

fromValue :: (a -> Value) -> Encoder a

Create an Encoder from a function returning a Value

jsonEncoder :: forall a. (ToJSON a, Typeable a) => Typed (Encoder a)

Create an encoder from a Aeson instance

jsonEncoderOf :: ToJSON a => Encoder a

encodeMaybeOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Maybe a))

Create an Encoder for a (Maybe a)

maybeOfEncoder :: Encoder a -> Encoder (Maybe a)

encodePairOf :: forall a b. (Typeable a, Typeable b) => Typed (Encoder a -> Encoder b -> Encoder (a, b))

Create an Encoder for a pair (a, b)

pairOfEncoder :: Encoder a -> Encoder b -> Encoder (a, b)

encodeTripleOf :: forall a b c. (Typeable a, Typeable b, Typeable c) => Typed (Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c))

Create an Encoder for a tripe (a, b, c)

tripleOfEncoder :: Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c)

encodeSetOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Set a))

Create an Encoder for a Set a

setOfEncoder :: Encoder a -> Encoder (Set a)

encodeListOf :: forall a. Typeable a => Typed (Encoder a -> Encoder [a])

Create an Encoder for a list [a]

listOfEncoder :: Encoder a -> Encoder [a]

encodeMapOf :: forall a b. (Typeable a, Typeable b) => Typed (KeyEncoder a -> Encoder b -> Encoder (Map a b))

Create an Encoder for a map a b

mapOfEncoder :: KeyEncoder a -> Encoder b -> Encoder (Map a b)

encodeNonEmptyOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (NonEmpty a))

Create an Encoder for a non-empty list (NonEmpty a)

nonEmptyOfEncoder :: Encoder a -> Encoder (NonEmpty a)

array :: [Value] -> Value

Shortcut function to create arrays

defaultEncoderOptions :: Registry _ _

textKeyEncoder :: KeyEncoder Text

stringKeyEncoder :: KeyEncoder String

defaultConstructorEncoder :: ConstructorEncoder

Default implementation, it can be overridden in a registry

makeEncoderFromConstructor :: Options -> FromConstructor -> (Value, Encoding)

Make an Encoder from Options and the representation of a constructor for a given value to encode

makeSumEncoding :: Options -> FromConstructor -> (Value, Encoding)

modifyFromConstructorWithOptions :: Options -> FromConstructor -> FromConstructor

Apply Options to the constructor name + field names and remove Nothing values if necessary

valuesToObject :: [Text] -> [(Value, Encoding)] -> (Value, Encoding)

Create an Object from a list of field names and a list of Values both as a Value and as an Encoding

module Data.Registry.Aeson.TH.Encoder

module Data.Registry.Aeson.TH.ThOptions