aeson-1.4.7.1: Fast JSON parsing and encoding
Safe HaskellNone
LanguageHaskell2010

Data.Aeson.Encoding.Internal

Synopsis

Encoding

newtype 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 

Fields

  • fromEncoding :: Builder

    Acquire the underlying bytestring builder.

Instances

Instances details
Eq (Encoding' a) # 
Instance details

Defined in Data.Aeson.Encoding.Internal

Methods

(==) :: Encoding' a -> Encoding' a -> Bool

(/=) :: Encoding' a -> Encoding' a -> Bool

Ord (Encoding' a) # 
Instance details

Defined in Data.Aeson.Encoding.Internal

Methods

compare :: Encoding' a -> Encoding' a -> Ordering

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

(<=) :: Encoding' a -> Encoding' a -> Bool

(>) :: Encoding' a -> Encoding' a -> Bool

(>=) :: Encoding' a -> Encoding' a -> Bool

max :: Encoding' a -> Encoding' a -> Encoding' a

min :: Encoding' a -> Encoding' a -> Encoding' a

Show (Encoding' a) # 
Instance details

Defined in Data.Aeson.Encoding.Internal

Methods

showsPrec :: Int -> Encoding' a -> ShowS

show :: Encoding' a -> String

showList :: [Encoding' a] -> ShowS

type Encoding = Encoding' Value #

Often used synonym for Encoding'.

unsafeToEncoding :: Builder -> Encoding' a #

Make Encoding from Builder.

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

data 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)

Constructors

Empty 
Value (Encoding' Series) 

Instances

Instances details
Semigroup Series # 
Instance details

Defined in Data.Aeson.Encoding.Internal

Methods

(<>) :: Series -> Series -> Series #

sconcat :: NonEmpty Series -> Series #

stimes :: Integral b => b -> Series -> Series #

Monoid Series # 
Instance details

Defined in Data.Aeson.Encoding.Internal

KeyValue Series # 
Instance details

Defined in Data.Aeson.Types.ToJSON

Methods

(.=) :: ToJSON v => Text -> v -> Series #

pairs :: Series -> Encoding #

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

pair :: Text -> Encoding -> Series #

Predicates

nullEncoding :: Encoding' a -> Bool #

Encoding constructors

bool :: Bool -> Encoding #

text :: Text -> Encoding' a #

lazyText :: Text -> Encoding' a #

list :: (a -> Encoding) -> [a] -> Encoding #

dict #

Arguments

:: (k -> Encoding' Text)

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

tuple :: Encoding' InArray -> Encoding #

Encode as a tuple.

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

(>*<) :: Encoding' a -> Encoding' b -> Encoding' InArray infixr 6 #

See tuple.

data InArray #

Type tag for tuples contents, see tuple.

(><) :: Encoding' a -> Encoding' a -> Encoding' a infixr 6 #

Decimal numbers

int8 :: Int8 -> Encoding #

int16 :: Int16 -> Encoding #

int32 :: Int32 -> Encoding #

int64 :: Int64 -> Encoding #

int :: Int -> Encoding #

word8 :: Word8 -> Encoding #

word16 :: Word16 -> Encoding #

word32 :: Word32 -> Encoding #

word64 :: Word64 -> Encoding #

word :: Word -> Encoding #

integer :: Integer -> Encoding #

float :: Float -> Encoding #

double :: Double -> Encoding #

scientific :: Scientific -> Encoding #

Decimal numbers as Text

int8Text :: Int8 -> Encoding' a #

int16Text :: Int16 -> Encoding' a #

int32Text :: Int32 -> Encoding' a #

int64Text :: Int64 -> Encoding' a #

intText :: Int -> Encoding' a #

word8Text :: Word8 -> Encoding' a #

word16Text :: Word16 -> Encoding' a #

word32Text :: Word32 -> Encoding' a #

word64Text :: Word64 -> Encoding' a #

wordText :: Word -> Encoding' a #

integerText :: Integer -> Encoding' a #

floatText :: Float -> Encoding' a #

doubleText :: Double -> Encoding' a #

scientificText :: Scientific -> Encoding' a #

Time

day :: Day -> Encoding' a #

value

JSON tokens