Moduleaeson-2.2.5.1Haskell2010

Data.Aeson.Encoding

Functions in this module return well-formed Encoding'. Polymorphic variants, which return Encoding a, return a textual JSON value, so it can be used as both Encoding' Text and Encoding = Encoding' Value.

Contents

Encoding
Predicates
Encoding constructors
Decimal numbers
Decimal numbers as Text
Time
value

Synopsis

type Encoding
newtype Encoding'
value encodingToLazyByteString
value fromEncoding
value unsafeToEncoding
data Series
value pairs
value pair
value pairStr
value pair'
value nullEncoding
value emptyArray_
value emptyObject_
value text
value lazyText
value shortText
value string
value list
value dict
value null_
value bool
value int8
value int16
value int32
value int64
value int
value word8
value word16
value word32
value word64
value word
value integer
value float
value double
value scientific
value int8Text
value int16Text
value int32Text
value int64Text
value intText
value word8Text
value word16Text
value word32Text
value word64Text
value wordText
value integerText
value floatText
value doubleText
value scientificText
value day
value month
value quarter
value localTime
value utcTime
value timeOfDay
value zonedTime
value value

Packageaeson-2.2.5.1
Exports57
LanguageHaskell2010
LicenceBSD-3-Clause
SourceEncoding.hs

Encoding

typetype Encoding = Encoding' Value

Source#

Often used synonym for Encoding'.

newtypenewtype Encoding' tag

Source#

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.5.1 · Data.Aeson.Types.ToJSON
KeyValueOmit Encoding SeriesDefined in aeson-2.2.5.1 · 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.5.1 · Data.Aeson.Types.ToJSON
GToJSON' Encoding arity U1Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
GToJSON' Encoding arity V1Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
ToJSON1 f => GToJSON' Encoding One (Rec1 f)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
ToJSON a => GToJSON' Encoding arity (K1 i a)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
(EncodeProduct arity a, EncodeProduct arity b) => GToJSON' Encoding arity (a :*: b)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
(ToJSON1 f, GToJSON' Encoding One g) => GToJSON' Encoding One (f :.: g)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
Eq (Encoding' a)Defined in aeson-2.2.5.1 · Data.Aeson.Encoding.Internal
Ord (Encoding' a)Defined in aeson-2.2.5.1 · Data.Aeson.Encoding.Internal
Show (Encoding' a)Defined in aeson-2.2.5.1 · Data.Aeson.Encoding.Internal
IsString (Encoding' a)Defined in aeson-2.2.5.1 · Data.Aeson.Encoding.Internal
a ~ Value => FromPairs (Encoding' a) SeriesDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON

valueencodingToLazyByteString :: Encoding' a -> ByteString

valuefromEncoding :: Encoding' tag -> Builder

Source#

Acquire the underlying bytestring builder.

valueunsafeToEncoding :: Builder -> Encoding' a

Source#

Make Encoding from Builder.

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

datadata Series

Source#

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.5.1 · Data.Aeson.Encoding.Internal
Monoid SeriesDefined in aeson-2.2.5.1 · Data.Aeson.Encoding.Internal
KeyValue Encoding SeriesDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
KeyValueOmit Encoding SeriesDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
e ~ Encoding => KeyValuePair e SeriesDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
a ~ Value => FromPairs (Encoding' a) SeriesDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON

valuepairs :: Series -> Encoding

Source#

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

valuepair :: Key -> Encoding -> Series

valuepairStr :: String -> Encoding -> Series

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

Predicates

valuenullEncoding :: Encoding' a -> Bool

Encoding constructors

valueemptyArray_ :: Encoding

valueemptyObject_ :: Encoding

valuetext :: Text -> Encoding' a

valuelazyText :: Text -> Encoding' a

valueshortText :: ShortText -> Encoding' a

Source#

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

Source#

Encode as JSON object

valuenull_ :: Encoding

valuebool :: Bool -> Encoding

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

Source#

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

Source#

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