Text.JSON.AttoJSON

Class and Data-Types for JSON Value

data JSValue

Data types for JSON value.

Constructors

JSString

JSON String

Fields

fromJSString :: !ByteString

JSNumber Rational

JSON Number

JSObject (Map ByteString JSValue)

JSON Object

JSArray [JSValue]

JSON Array

JSBool !Bool

JSON Bool

JSNull

JSON Null

Instances

Eq JSValue

Data JSValue

Show JSValue

Typeable JSValue

JSON JSValue

class JSON a where

Type Class for the value that can be converted from/into JSValue.

Methods

fromJSON :: JSValue -> Maybe a

Decode from JSValue

toJSON :: a -> JSValue

Encode into JSValue

Instances

JSON Bool

JSON Double

JSON Int

JSON Integer

JSON Rational

JSON String

JSON ()

JSON ByteString

JSON JSValue

JSON a => JSON [(String, a)]

JSON a => JSON [(ByteString, a)]

JSON a => JSON [a]

JSON a => JSON (Maybe a)

JSON a => JSON (Map String a)

JSON a => JSON (Map ByteString a)

Parsing & Printing

parseJSON :: ByteString -> Either String JSValue

Parse JSON source. Returns JSValue (Right) if succeed, Returns Left if failed.

The input string should be UTF8-encoded. Unicode escapes (e.g. "\u266B") are encoded in UTF8 by the parser, so incompatibilities will arise if you try to use AttoJSON with other encodings.

readJSON :: ByteString -> Maybe JSValue

Maybe version of parseJSON.

showJSON :: JSValue -> ByteString

Print JSValue as JSON source (not pretty).

The output string will be in UTF8 (provided the JSValue was constructed with UTF8 strings).

showJSON' :: JSValue -> ByteString

Same as showJSON, but escape Unicode Charactors.

Manipulating Objects

lookup :: JSON a => ByteString -> JSValue -> Maybe a

Get the value for field in Object and decode it.

getField :: JSON a => ByteString -> JSValue -> Maybe a

DEPRECATED: Alias of lookup. Use lookup.

findWithDefault :: JSON a => a -> ByteString -> JSValue -> a

lookup with default value.

lookupDeep :: JSON a => [ByteString] -> JSValue -> Maybe a

Same as lookup but it can process nested Object. ex:

   lookupDeep ["user", "name"] (JSObject [("user", JSObject [("name", JSString "hoge")])]) == Just "hoge"

getFields :: JSON a => [ByteString] -> JSValue -> Maybe a

DEPRECATED: Alias of lookupDeep

findDeepWithDefault :: JSON a => a -> [ByteString] -> JSValue -> a

getFields with default value.

updateField :: JSON a => ByteString -> a -> JSValue -> JSValue

Update or Insert the value for field in Object.