Data.Aeson.Pointer

Documentation

newtype Pointer

Constructors

Pointer

Fields

• _unPointer :: [Token]

Instances

Eq Pointer

Methods

(==) :: Pointer -> Pointer -> Bool

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

Show Pointer

Methods

showsPrec :: Int -> Pointer -> ShowS

show :: Pointer -> String

showList :: [Pointer] -> ShowS

Monoid Pointer

Methods

mempty :: Pointer

mappend :: Pointer -> Pointer -> Pointer

mconcat :: [Pointer] -> Pointer

Arbitrary Pointer

Methods

arbitrary :: Gen Pointer

shrink :: Pointer -> [Pointer]

FromJSON Pointer

Methods

parseJSON :: Value -> Parser Pointer

parseJSONList :: Value -> Parser [Pointer]

ToJSON Pointer

Methods

toJSON :: Pointer -> Value

toEncoding :: Pointer -> Encoding

toJSONList :: [Pointer] -> Value

toEncodingList :: [Pointer] -> Encoding

newtype Token

We don't try to distinguish between integer tokens and string tokens since all tokens start as strings, and all tokens can be used to resolve JSON objects.

Constructors

Token

Fields

• _unToken :: Text

Instances

Eq Token

Methods

(==) :: Token -> Token -> Bool

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

Show Token

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

Arbitrary Token

Methods

arbitrary :: Gen Token

shrink :: Token -> [Token]

escape :: Pointer -> Text

Unescaping

data FormatError

Constructors

InvalidFirstChar

JSON Pointers must either be empty or start with a /.

UnescapedTilde

Instances

Eq FormatError

Methods

(==) :: FormatError -> FormatError -> Bool

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

Show FormatError

Methods

showsPrec :: Int -> FormatError -> ShowS

show :: FormatError -> String

showList :: [FormatError] -> ShowS

unescape :: Text -> Either FormatError Pointer

JSON Pointers must either be empty or start with a /. This means that if you're turning a URI Fragment into a JSON Pointer you must drop the initial #.

Note that the unescaping happening here is not the same as URI decoding. If you are turning a URI fragment into a JSON Pointer you must URI decode the Text before using it as an argument to this function. There's an example of how to do this in the tests using "Network.HTTP.Types.URI.urlDecode" from http-types.

unescapeToken :: Text -> Maybe Token

For internal use by unescape.

Resolution

data ResolutionError

Constructors

ObjectLookupFailed

ArrayIndexInvalid

ArrayElemNotFound

ExpectedObjectOrArray

Instances

Eq ResolutionError

Methods

(==) :: ResolutionError -> ResolutionError -> Bool

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

Show ResolutionError

Methods

showsPrec :: Int -> ResolutionError -> ShowS

show :: ResolutionError -> String

showList :: [ResolutionError] -> ShowS

resolve :: Pointer -> Value -> Either ResolutionError Value

resolveToken :: Token -> Value -> Either ResolutionError Value

For internal use (or specialized applications that don't want to resolve an entire pointer at once).