Safe Haskell	None
Language	Haskell2010

Data.Aeson.Pointer

Contents

Representing pointers
Using pointers

Description

Synopsis

Documentation

newtype Pointer Source #

Pointer to a location in a JSON document.

Defined in RFC 6901 http://tools.ietf.org/html/rfc6901

Constructors

Pointer
Fields pointerPath :: Path

Instances

Eq Pointer Source #
Methods (==) :: Pointer -> Pointer -> Bool # (/=) :: Pointer -> Pointer -> Bool #
Ord Pointer Source #
Methods compare :: Pointer -> Pointer -> Ordering # (<) :: Pointer -> Pointer -> Bool # (<=) :: Pointer -> Pointer -> Bool # (>) :: Pointer -> Pointer -> Bool # (>=) :: Pointer -> Pointer -> Bool # max :: Pointer -> Pointer -> Pointer # min :: Pointer -> Pointer -> Pointer #
Show Pointer Source #
Methods showsPrec :: Int -> Pointer -> ShowS # show :: Pointer -> String # showList :: [Pointer] -> ShowS #
Semigroup Pointer Source #
Methods (<>) :: Pointer -> Pointer -> Pointer # sconcat :: NonEmpty Pointer -> Pointer # stimes :: Integral b => b -> Pointer -> Pointer #
Monoid Pointer Source #
Methods mempty :: Pointer # mappend :: Pointer -> Pointer -> Pointer # mconcat :: [Pointer] -> Pointer #
ToJSON Pointer Source #
Methods toJSON :: Pointer -> Value # toEncoding :: Pointer -> Encoding # toJSONList :: [Pointer] -> Value # toEncodingList :: [Pointer] -> Encoding #
FromJSON Pointer Source #
Methods parseJSON :: Value -> Parser Pointer # parseJSONList :: Value -> Parser [Pointer] #

data Key Source #

Path components to traverse a single layer of a JSON document.

Constructors

OKey Text	Traverse a `Value` with an `Object` constructor.
AKey Int	Traverse a `Value` with an `Array` constructor.

Instances

Eq Key Source #
Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key Source #
Methods compare :: Key -> Key -> Ordering # (<) :: Key -> Key -> Bool # (<=) :: Key -> Key -> Bool # (>) :: Key -> Key -> Bool # (>=) :: Key -> Key -> Bool # max :: Key -> Key -> Key # min :: Key -> Key -> Key #
Show Key Source #
Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
ToJSON Key Source #
Methods toJSON :: Key -> Value # toEncoding :: Key -> Encoding # toJSONList :: [Key] -> Value # toEncodingList :: [Key] -> Encoding #
FromJSON Key Source #
Methods parseJSON :: Value -> Parser Key # parseJSONList :: Value -> Parser [Key] #

type Path = [Key] Source #

A sequence of Keys forms a path through a JSON document.

Representing pointers

formatPointer :: Pointer -> Text Source #

Format a Pointer as described in RFC 6901.

>>> formatPointer (Pointer [])
""
>>> formatPointer (Pointer [OKey ""])
"/"
>>> formatPointer (Pointer [OKey " "])
"/ "
>>> formatPointer (Pointer [OKey "foo"])
"/foo"
>>> formatPointer (Pointer [OKey "foo", AKey 0])
"/foo/0"
>>> formatPointer (Pointer [OKey "a/b"])
"/a~1b"
>>> formatPointer (Pointer [OKey "c%d"])
"/c%d"
>>> formatPointer (Pointer [OKey "e^f"])
"/e^f"
>>> formatPointer (Pointer [OKey "g|h"])
"/g|h"
>>> formatPointer (Pointer [OKey "i\\j"])
"/i\\j"
>>> formatPointer (Pointer [OKey "k\"l"])
"/k\"l"
>>> formatPointer (Pointer [OKey "m~n"])
"/m~0n"

parsePointer :: Text -> Parser Pointer Source #

Parse a Pointer as described in RFC 6901.

Using pointers

get :: Pointer -> Value -> Result Value Source #

Follow a Pointer through a JSON document as described in RFC 6901.

pointerFailure :: Pointer -> Value -> Result a Source #

Report an error while following a pointer.