Text.JSON5

Serialising Haskell values to and from JSON5 values.

JSON5 Types

data JSValue

Constructors

JSNull

JSBool !Bool

JSNumber JSNumber

JSString JSString

JSArray [JSValue]

JSObject (JSObject JSValue)

Instances

Eq JSValue

Defined in Text.JSON5.Types

Methods

(==) :: JSValue -> JSValue -> Bool

(/=) :: JSValue -> JSValue -> Bool

Ord JSValue

Defined in Text.JSON5.Types

Methods

compare :: JSValue -> JSValue -> Ordering

(<) :: JSValue -> JSValue -> Bool

(<=) :: JSValue -> JSValue -> Bool

(>) :: JSValue -> JSValue -> Bool

(>=) :: JSValue -> JSValue -> Bool

max :: JSValue -> JSValue -> JSValue

min :: JSValue -> JSValue -> JSValue

Read JSValue

Defined in Text.JSON5.Types

Methods

readsPrec :: Int -> ReadS JSValue

readList :: ReadS [JSValue]

readPrec :: ReadPrec JSValue

readListPrec :: ReadPrec [JSValue]

Show JSValue

Defined in Text.JSON5.Types

Methods

showsPrec :: Int -> JSValue -> ShowS

show :: JSValue -> String

showList :: [JSValue] -> ShowS

IsString JSValue

Defined in Text.JSON5.Types

Methods

fromString :: String -> JSValue

JSON5 JSValue

To ensure we generate valid JSON5, we map Haskell types to JSValue internally, then pretty print that.

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result JSValue

showJSON :: JSValue -> JSValue

readJSONs :: JSValue -> Result [JSValue]

showJSONs :: [JSValue] -> JSValue

Serialization to and from JSValues

class JSON5 a where

The class of types serialisable to and from JSON5

Minimal complete definition

readJSON, showJSON

Methods

readJSON :: JSValue -> Result a

showJSON :: a -> JSValue

readJSONs :: JSValue -> Result [a]

showJSONs :: [a] -> JSValue

Instances

JSON5 Bool

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Bool

showJSON :: Bool -> JSValue

readJSONs :: JSValue -> Result [Bool]

showJSONs :: [Bool] -> JSValue

JSON5 Char

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Char

showJSON :: Char -> JSValue

readJSONs :: JSValue -> Result [Char]

showJSONs :: [Char] -> JSValue

JSON5 Double

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Double

showJSON :: Double -> JSValue

readJSONs :: JSValue -> Result [Double]

showJSONs :: [Double] -> JSValue

JSON5 Float

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Float

showJSON :: Float -> JSValue

readJSONs :: JSValue -> Result [Float]

showJSONs :: [Float] -> JSValue

JSON5 Int

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Int

showJSON :: Int -> JSValue

readJSONs :: JSValue -> Result [Int]

showJSONs :: [Int] -> JSValue

JSON5 Int8

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Int8

showJSON :: Int8 -> JSValue

readJSONs :: JSValue -> Result [Int8]

showJSONs :: [Int8] -> JSValue

JSON5 Int16

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Int16

showJSON :: Int16 -> JSValue

readJSONs :: JSValue -> Result [Int16]

showJSONs :: [Int16] -> JSValue

JSON5 Int32

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Int32

showJSON :: Int32 -> JSValue

readJSONs :: JSValue -> Result [Int32]

showJSONs :: [Int32] -> JSValue

JSON5 Int64

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Int64

showJSON :: Int64 -> JSValue

readJSONs :: JSValue -> Result [Int64]

showJSONs :: [Int64] -> JSValue

JSON5 Integer

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Integer

showJSON :: Integer -> JSValue

readJSONs :: JSValue -> Result [Integer]

showJSONs :: [Integer] -> JSValue

JSON5 Ordering

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Ordering

showJSON :: Ordering -> JSValue

readJSONs :: JSValue -> Result [Ordering]

showJSONs :: [Ordering] -> JSValue

JSON5 Word

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Word

showJSON :: Word -> JSValue

readJSONs :: JSValue -> Result [Word]

showJSONs :: [Word] -> JSValue

JSON5 Word8

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Word8

showJSON :: Word8 -> JSValue

readJSONs :: JSValue -> Result [Word8]

showJSONs :: [Word8] -> JSValue

JSON5 Word16

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Word16

showJSON :: Word16 -> JSValue

readJSONs :: JSValue -> Result [Word16]

showJSONs :: [Word16] -> JSValue

JSON5 Word32

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Word32

showJSON :: Word32 -> JSValue

readJSONs :: JSValue -> Result [Word32]

showJSONs :: [Word32] -> JSValue

JSON5 Word64

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Word64

showJSON :: Word64 -> JSValue

readJSONs :: JSValue -> Result [Word64]

showJSONs :: [Word64] -> JSValue

JSON5 ()

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result ()

showJSON :: () -> JSValue

readJSONs :: JSValue -> Result [()]

showJSONs :: [()] -> JSValue

JSON5 ByteString

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result ByteString

showJSON :: ByteString -> JSValue

readJSONs :: JSValue -> Result [ByteString]

showJSONs :: [ByteString] -> JSValue

JSON5 ByteString

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result ByteString

showJSON :: ByteString -> JSValue

readJSONs :: JSValue -> Result [ByteString]

showJSONs :: [ByteString] -> JSValue

JSON5 IntSet

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result IntSet

showJSON :: IntSet -> JSValue

readJSONs :: JSValue -> Result [IntSet]

showJSONs :: [IntSet] -> JSValue

JSON5 Text

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result Text

showJSON :: Text -> JSValue

readJSONs :: JSValue -> Result [Text]

showJSONs :: [Text] -> JSValue

JSON5 JSString

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result JSString

showJSON :: JSString -> JSValue

readJSONs :: JSValue -> Result [JSString]

showJSONs :: [JSString] -> JSValue

JSON5 JSValue

To ensure we generate valid JSON5, we map Haskell types to JSValue internally, then pretty print that.

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result JSValue

showJSON :: JSValue -> JSValue

readJSONs :: JSValue -> Result [JSValue]

showJSONs :: [JSValue] -> JSValue

JSON5 a => JSON5 [a]

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result [a]

showJSON :: [a] -> JSValue

readJSONs :: JSValue -> Result [[a]]

showJSONs :: [[a]] -> JSValue

JSON5 a => JSON5 (Maybe a)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (Maybe a)

showJSON :: Maybe a -> JSValue

readJSONs :: JSValue -> Result [Maybe a]

showJSONs :: [Maybe a] -> JSValue

JSON5 a => JSON5 (IntMap a)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (IntMap a)

showJSON :: IntMap a -> JSValue

readJSONs :: JSValue -> Result [IntMap a]

showJSONs :: [IntMap a] -> JSValue

(Ord a, JSON5 a) => JSON5 (Set a)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (Set a)

showJSON :: Set a -> JSValue

readJSONs :: JSValue -> Result [Set a]

showJSONs :: [Set a] -> JSValue

JSON5 a => JSON5 (JSObject a)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (JSObject a)

showJSON :: JSObject a -> JSValue

readJSONs :: JSValue -> Result [JSObject a]

showJSONs :: [JSObject a] -> JSValue

(JSON5 a, JSON5 b) => JSON5 (Either a b)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (Either a b)

showJSON :: Either a b -> JSValue

readJSONs :: JSValue -> Result [Either a b]

showJSONs :: [Either a b] -> JSValue

(JSON5 a, JSON5 b) => JSON5 (a, b)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (a, b)

showJSON :: (a, b) -> JSValue

readJSONs :: JSValue -> Result [(a, b)]

showJSONs :: [(a, b)] -> JSValue

(Ix i, JSON5 i, JSON5 e) => JSON5 (Array i e)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (Array i e)

showJSON :: Array i e -> JSValue

readJSONs :: JSValue -> Result [Array i e]

showJSONs :: [Array i e] -> JSValue

(Ord a, JSON5 a, JSON5 b) => JSON5 (Map a b)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (Map a b)

showJSON :: Map a b -> JSValue

readJSONs :: JSValue -> Result [Map a b]

showJSONs :: [Map a b] -> JSValue

(JSON5 a, JSON5 b, JSON5 c) => JSON5 (a, b, c)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (a, b, c)

showJSON :: (a, b, c) -> JSValue

readJSONs :: JSValue -> Result [(a, b, c)]

showJSONs :: [(a, b, c)] -> JSValue

(JSON5 a, JSON5 b, JSON5 c, JSON5 d) => JSON5 (a, b, c, d)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (a, b, c, d)

showJSON :: (a, b, c, d) -> JSValue

readJSONs :: JSValue -> Result [(a, b, c, d)]

showJSONs :: [(a, b, c, d)] -> JSValue

Encoding and Decoding

data Result a

A type for parser results

Constructors

Ok a

Error String

Instances

Monad Result

Defined in Text.JSON5

Methods

(>>=) :: Result a -> (a -> Result b) -> Result b

(>>) :: Result a -> Result b -> Result b

return :: a -> Result a

fail :: String -> Result a

Functor Result

Defined in Text.JSON5

Methods

fmap :: (a -> b) -> Result a -> Result b

(<$) :: a -> Result b -> Result a

Applicative Result

Defined in Text.JSON5

Methods

pure :: a -> Result a

(<*>) :: Result (a -> b) -> Result a -> Result b

liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c

(*>) :: Result a -> Result b -> Result b

(<*) :: Result a -> Result b -> Result a

Alternative Result

Defined in Text.JSON5

Methods

empty :: Result a

(<|>) :: Result a -> Result a -> Result a

some :: Result a -> Result [a]

many :: Result a -> Result [a]

MonadPlus Result

Defined in Text.JSON5

Methods

mzero :: Result a

mplus :: Result a -> Result a -> Result a

Eq a => Eq (Result a)

Defined in Text.JSON5

Methods

(==) :: Result a -> Result a -> Bool

(/=) :: Result a -> Result a -> Bool

Show a => Show (Result a)

Defined in Text.JSON5

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

encode :: JSON5 a => a -> String

Encode a Haskell value into a string, in JSON5 format.

This is a superset of JSON5, as types other than Array and Object are allowed at the top level.

decode :: JSON5 a => String -> Result a

Decode a String representing a JSON5 value (either an object, array, bool, number, null)

This is a superset of JSON5, as types other than Array and Object are allowed at the top level.

encodeStrict :: JSON5 a => a -> String

Encode a value as a String in strict JSON format. This follows the spec, and requires all values at the top level to be wrapped in either an Array or Object. JSON5 types to be an Array or Object.

decodeStrict :: JSON5 a => String -> Result a

Decode a String representing a strict JSON value. This follows the spec, and requires top level JSON5 types to be an Array or Object.

Wrapper Types

data JSString

Instances

Eq JSString

Defined in Text.JSON5.Types

Methods

(==) :: JSString -> JSString -> Bool

(/=) :: JSString -> JSString -> Bool

Ord JSString

Defined in Text.JSON5.Types

Methods

compare :: JSString -> JSString -> Ordering

(<) :: JSString -> JSString -> Bool

(<=) :: JSString -> JSString -> Bool

(>) :: JSString -> JSString -> Bool

(>=) :: JSString -> JSString -> Bool

max :: JSString -> JSString -> JSString

min :: JSString -> JSString -> JSString

Read JSString

Defined in Text.JSON5.Types

Methods

readsPrec :: Int -> ReadS JSString

readList :: ReadS [JSString]

readPrec :: ReadPrec JSString

readListPrec :: ReadPrec [JSString]

Show JSString

Defined in Text.JSON5.Types

Methods

showsPrec :: Int -> JSString -> ShowS

show :: JSString -> String

showList :: [JSString] -> ShowS

IsString JSString

Defined in Text.JSON5.Types

Methods

fromString :: String -> JSString

JSKey JSString

Defined in Text.JSON5

Methods

toJSKey :: JSString -> String

fromJSKey :: String -> Maybe JSString

JSON5 JSString

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result JSString

showJSON :: JSString -> JSValue

readJSONs :: JSValue -> Result [JSString]

showJSONs :: [JSString] -> JSValue

toJSString :: String -> JSString

fromJSString :: JSString -> String

data JSObject a

Instances

Eq a => Eq (JSObject a)

Defined in Text.JSON5.Types

Methods

(==) :: JSObject a -> JSObject a -> Bool

(/=) :: JSObject a -> JSObject a -> Bool

Ord a => Ord (JSObject a)

Defined in Text.JSON5.Types

Methods

compare :: JSObject a -> JSObject a -> Ordering

(<) :: JSObject a -> JSObject a -> Bool

(<=) :: JSObject a -> JSObject a -> Bool

(>) :: JSObject a -> JSObject a -> Bool

(>=) :: JSObject a -> JSObject a -> Bool

max :: JSObject a -> JSObject a -> JSObject a

min :: JSObject a -> JSObject a -> JSObject a

Read a => Read (JSObject a)

Defined in Text.JSON5.Types

Methods

readsPrec :: Int -> ReadS (JSObject a)

readList :: ReadS [JSObject a]

readPrec :: ReadPrec (JSObject a)

readListPrec :: ReadPrec [JSObject a]

Show a => Show (JSObject a)

Defined in Text.JSON5.Types

Methods

showsPrec :: Int -> JSObject a -> ShowS

show :: JSObject a -> String

showList :: [JSObject a] -> ShowS

JSON5 a => JSON5 (JSObject a)

Defined in Text.JSON5

Methods

readJSON :: JSValue -> Result (JSObject a)

showJSON :: JSObject a -> JSValue

readJSONs :: JSValue -> Result [JSObject a]

showJSONs :: [JSObject a] -> JSValue

toJSObject :: [(String, a)] -> JSObject a

fromJSObject :: JSObject a -> [(String, a)]

resultToEither :: Result a -> Either String a

Map Results to Eithers

Serialization to and from Strings.

Reading JSON5

readJSNull :: GetJSON JSValue

Read the JSON5 null type

readJSBool :: GetJSON JSValue

Read the JSON5 Bool type

readJSString :: Char -> GetJSON JSValue

Strings

Read the JSON5 String type

readJSRational :: GetJSON Rational

Numbers

Read an Integer or Double in JSON5 format, returning a Rational

readJSArray :: GetJSON JSValue

Objects & Arrays

Read a list in JSON5 format

readJSObject :: GetJSON JSValue

Read an object in JSON5 format

readJSValue :: GetJSON JSValue

Read one of several possible JS types

Writing JSON5

showJSNull :: ShowS

Write the JSON5 null type

showJSBool :: Bool -> ShowS

Write the JSON5 Bool type

showJSArray :: [JSValue] -> ShowS

Show a list in JSON format

showJSRational :: Rational -> ShowS

Show a Rational in JSON5 format

showJSInfNaN :: Float -> ShowS

Show a Infinity or NaN in JSON5 format

showJSObject :: JSObject JSValue -> ShowS

Show an association list in JSON format

showJSValue :: JSValue -> ShowS

Show JSON5 values

Instance helpers

makeObj :: [(String, JSValue)] -> JSValue

valFromObj :: JSON5 a => String -> JSObject JSValue -> Result a

Pull a value out of a JSON5 object.

class JSKey a where

Haskell types that can be used as keys in JSON5 objects.

Methods

toJSKey :: a -> String

fromJSKey :: String -> Maybe a

Instances

JSKey Int

Defined in Text.JSON5

Methods

toJSKey :: Int -> String

fromJSKey :: String -> Maybe Int

JSKey String

Defined in Text.JSON5

Methods

toJSKey :: String -> String

fromJSKey :: String -> Maybe String

JSKey JSString

Defined in Text.JSON5

Methods

toJSKey :: JSString -> String

fromJSKey :: String -> Maybe JSString

encJSDict :: (JSKey a, JSON5 b) => [(a, b)] -> JSValue

Encode an association list as JSValue value.

decJSDict :: (JSKey a, JSON5 b) => String -> JSValue -> Result [(a, b)]

Decode a JSValue value into an association list.