Data.Aeson.Encoding.Internal · aeson-2.2.3.0

Encoding

11 declarations

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.

Constructors

Encoding
- fromEncoding :: Builder
  Acquire the underlying bytestring builder.

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

typetype Encoding = Encoding' Value

#

Often used synonym for Encoding'.

valueencodingToLazyByteString :: Encoding' a -> ByteString

#

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!

valueretagEncoding :: Encoding' a -> Encoding' b

#

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

#

valueunsafePairSBS :: ShortByteString -> Encoding -> Series

#

A variant of a pair where key is already encoded including the quotes and colon.

pair "foo" v = unsafePair "\"foo\":" v

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

#

Predicates

1 declaration

valuenullEncoding :: Encoding' a -> Bool

#

Encoding constructors

19 declarations

valueemptyArray_ :: Encoding

#

valueemptyObject_ :: Encoding

#

valuewrapObject :: Encoding' a -> Encoding

#

valuewrapArray :: Encoding' a -> Encoding

#

valuenull_ :: Encoding

#

valuebool :: Bool -> Encoding

#

valuekey :: Key -> Encoding' a

#

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

#

Encode as JSON object

valuetuple :: Encoding' InArray -> Encoding

#

Encode as a tuple.

@ toEncoding (X a b c) = tuple $ toEncoding a >*< toEncoding b >*< toEncoding c

value(>*<) :: Encoding' a -> Encoding' b -> Encoding' InArray

#

See tuple.

datadata InArray

#

Type tag for tuples contents, see tuple.

valueempty :: Encoding' a

#

value(><) :: Encoding' a -> Encoding' a -> Encoding' a

#

valueeconcat :: [Encoding' a] -> Encoding' a

#

Decimal numbers

valueint8 :: Int8 -> Encoding

#

valueint16 :: Int16 -> Encoding

#

valueint32 :: Int32 -> Encoding

#

valueint64 :: Int64 -> Encoding

#

valueint :: Int -> Encoding

#

valueword8 :: Word8 -> Encoding

#

valueword16 :: Word16 -> Encoding

#

valueword32 :: Word32 -> Encoding

#

valueword64 :: Word64 -> Encoding

#

valueword :: Word -> Encoding

#

valueinteger :: Integer -> Encoding

#

valuefloat :: Float -> Encoding

#

valuedouble :: Double -> Encoding

#

Example1 expression

>>> double 42"42.0"

Example1 expression

>>> double (0/0)"null"

Example1 expression

>>> double (1/0)"\"+inf\""

Example1 expression

>>> double (-23/0)"\"-inf\""

valuescientific :: Scientific -> Encoding

#

Decimal numbers as Text

valueint8Text :: Int8 -> Encoding' a

#

valueint16Text :: Int16 -> Encoding' a

#

valueint32Text :: Int32 -> Encoding' a

#

valueint64Text :: Int64 -> Encoding' a

#

valueintText :: Int -> Encoding' a

#

valueword8Text :: Word8 -> Encoding' a

#

valueword16Text :: Word16 -> Encoding' a

#

valueword32Text :: Word32 -> Encoding' a

#

valueword64Text :: Word64 -> Encoding' a

#

valuewordText :: Word -> Encoding' a

#

valueintegerText :: Integer -> Encoding' a

#

valuefloatText :: Float -> Encoding' a

#

valuedoubleText :: Double -> Encoding' a

#

Example1 expression

>>> doubleText 42"\"42.0\""

Example1 expression

>>> doubleText (0/0)"\"NaN\""

Example1 expression

>>> doubleText (1/0)"\"+inf\""

Example1 expression

>>> doubleText (-23/0)"\"-inf\""

valuescientificText :: Scientific -> Encoding' a

#

Time

valueday :: Day -> Encoding' a

#

valuemonth :: Month -> Encoding' a

#

valuequarter :: Quarter -> Encoding' a

#

valuelocalTime :: LocalTime -> Encoding' a

#

valueutcTime :: UTCTime -> Encoding' a

#

valuetimeOfDay :: TimeOfDay -> Encoding' a

#

valuezonedTime :: ZonedTime -> Encoding' a

#

value

valuevalue :: Value -> Encoding

#

JSON tokens

valuecomma :: Encoding' a

#

valuecolon :: Encoding' a

#

valueopenBracket :: Encoding' a

#

valuecloseBracket :: Encoding' a

#

valueopenCurly :: Encoding' a

#

valuecloseCurly :: Encoding' a

#