Json.Path

Documentation

data Path

A path to an object.

Constructors

Key !ShortText !Path

JSON path element of a key into an object, "object.key".

Index !Int !Path

JSON path element of an index into an array, "array[index]". Negative numbers result in undefined behavior.

Nil

Instances

Show Path

Defined in Json.Path

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

Eq Path

Defined in Json.Path

Methods

(==) :: Path -> Path -> Bool

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

Encoding

encode :: Path -> ShortText

Encode a path.

>>> encode (Key "foo" $ Index 5 $ Key "bar" $ Nil)

builderUtf8 :: Path -> Builder

Lookup

query :: Path -> Value -> Maybe Value

Search for an element at the given path. Returns Nothing if anything in the path is missing.

query' :: Path -> Value -> Value

Variant of query that returns Null if anything in the path is missing.

Reverse

reverse :: Path -> Path