Safe Haskell	None
Language	Haskell2010

Data.Registry.Aeson.Encoder

Contents

ENCODER DATA TYPE
ENCODE VALUES
CREATE ENCODERS
COMBINATORS
TEMPLATE HASKELL

Synopsis

newtype Encoder a = Encoder {
- encode :: a -> (Value, Encoding)
}
encodeByteString :: Encoder a -> a -> ByteString
encodeValue :: Encoder a -> a -> Value
fromValue :: (a -> Value) -> Encoder a
jsonEncoder :: forall a. (ToJSON a, Typeable a) => Typed (Encoder a)
jsonEncoderOf :: ToJSON a => Encoder a
encodeMaybeOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (Maybe a))
maybeOfEncoder :: Encoder a -> Encoder (Maybe a)
encodePairOf :: forall a b. (Typeable a, Typeable b) => Typed (Encoder a -> Encoder b -> Encoder (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))
tripleOfEncoder :: Encoder a -> Encoder b -> Encoder c -> Encoder (a, b, c)
encodeListOf :: forall a. Typeable a => Typed (Encoder a -> Encoder [a])
listOfEncoder :: Encoder a -> Encoder [a]
encodeNonEmptyOf :: forall a. Typeable a => Typed (Encoder a -> Encoder (NonEmpty a))
nonEmptyOfEncoder :: Encoder a -> Encoder (NonEmpty a)
array :: [Value] -> Value
makeEncoder :: Name -> ExpQ
makeConstructorsEncoder :: [Con] -> ExpQ
makeMatchClause :: [Name] -> [Type] -> Con -> MatchQ
data FromConstructor = FromConstructor {
- fromConstructorNames :: [Text]
- fromConstructorTypes :: [Text]
- fromConstructorName :: Text
- fromConstructorFieldNames :: [Text]
- fromConstructorValues :: [(Value, Encoding)]
}
modifyFromConstructorWithOptions :: Options -> FromConstructor -> FromConstructor
makeEncoderFromConstructor :: Options -> FromConstructor -> (Value, Encoding)
makeSumEncoding :: Options -> FromConstructor -> (Value, Encoding)
valuesToObject :: [Text] -> [(Value, Encoding)] -> (Value, Encoding)

ENCODER DATA TYPE

newtype Encoder a Source #

Constructors

Encoder
Fields encode :: a -> (Value, Encoding)

Instances

Instances details

Contravariant Encoder Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods contramap :: (a -> b) -> Encoder b -> Encoder a # (>$) :: b -> Encoder b -> Encoder a #

ENCODE VALUES

encodeByteString :: Encoder a -> a -> ByteString Source #

encodeValue :: Encoder a -> a -> Value Source #

CREATE ENCODERS

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

Create an Encoder from a function returning a Value

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

Create an encoder from a Aeson instance

jsonEncoderOf :: ToJSON a => Encoder a Source #

COMBINATORS

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

Create an Encoder for a (Maybe a)

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

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

Create an Encoder for a pair (a, b)

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

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

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

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

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

Create an Encoder for a list [a]

listOfEncoder :: Encoder a -> Encoder [a] Source #

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

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

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

array :: [Value] -> Value Source #

Shortcut function to create arrays

TEMPLATE HASKELL

makeEncoder :: Name -> ExpQ Source #

Make an Encoder for a given data type Usage: $(makeEncoder ''MyDataType) <: otherEncoders

makeConstructorsEncoder :: [Con] -> ExpQ Source #

makeMatchClause :: [Name] -> [Type] -> Con -> MatchQ Source #

Make the match clause for a constructor given - the list of all the encoder types - the constructor name - the constructor index in the list of all the constructors for the encoded data type T1 a0 a1 ... -> makeEncoderFromConstructor o (FromConstructor names types cName fieldNames values)

data FromConstructor Source #

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

Instances details

Eq FromConstructor Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods (==) :: FromConstructor -> FromConstructor -> Bool # (/=) :: FromConstructor -> FromConstructor -> Bool #
Show FromConstructor Source #
Instance details Defined in Data.Registry.Aeson.Encoder Methods showsPrec :: Int -> FromConstructor -> ShowS # show :: FromConstructor -> String # showList :: [FromConstructor] -> ShowS #

modifyFromConstructorWithOptions :: Options -> FromConstructor -> FromConstructor Source #

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

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

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

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

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

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