-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | JSON Pointer library
--   
@package hjsonpointer
@version 0.2.0.1

module Data.JsonPointer
newtype JsonPointer
JsonPointer :: [Text] -> JsonPointer
_unJsonPointer :: JsonPointer -> [Text]
data PointerFormatError

-- | The Text to build a JSON Pointer must either be empty or start with a
--   "/".
InvalidFirstChar :: PointerFormatError
UnescapedTilde :: PointerFormatError
data ResolutionError
ObjectLookupFailed :: ResolutionError
ArrayIndexInvalid :: ResolutionError
ArrayElemNotFound :: ResolutionError
ExpectedObjectOrArray :: ResolutionError

-- | The Text to build a JSON Pointer must either be empty or start with a
--   "/". If you're turning a URI Fragment into a JSON Pointer you must
--   drop the initial "#".
jsonPointer :: Text -> Either PointerFormatError JsonPointer
resolvePointer :: JsonPointer -> Value -> Either ResolutionError Value

-- | For internal use and specialized applications that don't want to
--   resolve the entire pointer at once.
resolveRefTok :: JsonPointer -> Value -> Either ResolutionError (JsonPointer, Value)
instance Eq JsonPointer
instance Show JsonPointer
instance Eq PointerFormatError
instance Show PointerFormatError
instance Eq ResolutionError
instance Show ResolutionError