Data.Aeson.Encoding · aeson-2.2.3.0

Encoding

10 declarations

typetype Encoding = Encoding' Value

#

Often used synonym for Encoding'.

newtypenewtype Encoding' tag

#

An encoding of a JSON value.

tag represents which kind of JSON the Encoding is encoding to, we reuse Text and Value as tags here.

Instances14KeyValue, KeyValueOmit, SumToJSON', GToJSON', Eq, Ord, …

KeyValue Encoding SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
KeyValueOmit Encoding SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
(GToJSON' Encoding arity a, ConsToJSON Encoding arity a, Constructor c) => SumToJSON' TwoElemArray Encoding arity (C1 c a)Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
GToJSON' Encoding arity U1Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
GToJSON' Encoding arity V1Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
ToJSON1 f => GToJSON' Encoding One (Rec1 f)Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
ToJSON a => GToJSON' Encoding arity (K1 i a)Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
(EncodeProduct arity a, EncodeProduct arity b) => GToJSON' Encoding arity (a :*: b)Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
(ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g)Defined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
Eq (Encoding' a)Defined in aeson-2.2.3.0 · Data.Aeson.Encoding.Internal
Ord (Encoding' a)Defined in aeson-2.2.3.0 · Data.Aeson.Encoding.Internal
Show (Encoding' a)Defined in aeson-2.2.3.0 · Data.Aeson.Encoding.Internal
IsString (Encoding' a)Defined in aeson-2.2.3.0 · Data.Aeson.Encoding.Internal
a ~ Value => FromPairs (Encoding' a) SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON

valueencodingToLazyByteString :: Encoding' a -> ByteString

#

valuefromEncoding :: Encoding' tag -> Builder

#

Acquire the underlying bytestring builder.

valueunsafeToEncoding :: Builder -> Encoding' a

#

Make Encoding from Builder.

Use with care! You have to make sure that the passed Builder is a valid JSON Encoding!

datadata Series

#

A series of values that, when encoded, should be separated by commas. Since 0.11.0.0, the .= operator is overloaded to create either (Text, Value) or Series. You can use Series when encoding directly to a bytestring builder as in the following example:

toEncoding (Person name age) = pairs ("name" .= name <> "age" .= age)

Instances6Semigroup, Monoid, KeyValue, KeyValueOmit, KeyValuePair, FromPairs

Semigroup SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Encoding.Internal
Monoid SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Encoding.Internal
KeyValue Encoding SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
KeyValueOmit Encoding SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
e ~ Encoding => KeyValuePair e SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON
a ~ Value => FromPairs (Encoding' a) SeriesDefined in aeson-2.2.3.0 · Data.Aeson.Types.ToJSON

valuepairs :: Series -> Encoding

#

Encode a series of key/value pairs, separated by commas.

valuepair :: Key -> Encoding -> Series

#

valuepairStr :: String -> Encoding -> Series

#

valuepair' :: Encoding' Key -> Encoding -> Series

#

Predicates

1 declaration

valuenullEncoding :: Encoding' a -> Bool

#

Encoding constructors

10 declarations

valueemptyArray_ :: Encoding

#

valueemptyObject_ :: Encoding

#

valuetext :: Text -> Encoding' a

#

valuelazyText :: Text -> Encoding' a

#

valueshortText :: ShortText -> Encoding' a

#

valuestring :: String -> Encoding' a

#

valuelist :: (a -> Encoding) -> [a] -> Encoding

#

valuedict

:: (k -> Encoding' Key)
key encoding
-> (v -> Encoding)
value encoding
-> (forall a. (k -> v -> a -> a) -> a -> m -> a)
foldrWithKey - indexed fold
-> m
container
-> Encoding