Safe Haskell	Safe-Inferred
Language	Haskell2010

Aeson.Match.QQ

Synopsis

match :: Matcher Value -> Value -> Either (NonEmpty Error) (HashMap Text Value)
qq :: QuasiQuoter
data Error
data TypeMismatch = MkTypeMismatch {
- path :: Path
- expected :: Type
- matcher :: Matcher Value
- given :: Value
}
data Mismatch = MkMismatch {
- path :: Path
- matcher :: Matcher Value
- given :: Value
}
data MissingPathElem = MkMissingPathElem {
- path :: Path
- missing :: PathElem
}
data ExtraArrayValues = MkExtraArrayValues {
- path :: Path
- values :: Vector Value
}
data ExtraObjectValues = MkExtraObjectValues {
- path :: Path
- values :: HashMap Text Value
}
prettyError :: Error -> String
data Matcher ext
- = Hole (Maybe HoleSig) (Maybe Text)
- | Null
- | Bool Bool
- | Number Scientific
- | String Text
- | StringCI (CI Text)
- | Array (Array ext)
- | ArrayUO (Array ext)
- | Object (Object ext)
- | Ext ext
type Array ext = Box (Vector (Matcher ext))
type Object ext = Box (HashMap Text (Matcher ext))
data Box a = Box {
- values :: a
- extra :: Bool
}
data HoleSig = HoleSig {
- type_ :: Type
- nullable :: Bool
}
data Type
- = BoolT
- | NumberT
- | StringT
- | StringCIT
- | ArrayT
- | ArrayUOT
- | ObjectT
newtype Path = Path {
- unPath :: [PathElem]
}
data PathElem
- = Key Text
- | Idx Int
parse :: ByteString -> Either String (Matcher Exp)

Documentation

match Source #

Arguments

:: Matcher Value
-> Value
-> Either (NonEmpty Error) (HashMap Text Value)	Either a non-empty list of errors, or a mapping from named _holes to their values.

Test if a Matcher matches a Value.

qq :: QuasiQuoter Source #

Construct a Matcher.

data Error Source #

Various errors that can happen when a matcher tries to match a Value.

Constructors

Mismatch Mismatch	The type of the value is correct, but the value itself is wrong
Mistype TypeMismatch	The type of the value is wrong
MissingPathElem MissingPathElem	The request path is missing in the value
ExtraArrayValues ExtraArrayValues	Unexpected extra values in an array
ExtraObjectValues ExtraObjectValues	Unexpected extra key-value pairs in an object

Instances

Instances details

ToJSON Error Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: Error -> Value # toEncoding :: Error -> Encoding # toJSONList :: [Error] -> Value # toEncodingList :: [Error] -> Encoding #
Show Error Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Pretty Error Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> Error -> Doc # pPrint :: Error -> Doc # pPrintList :: PrettyLevel -> [Error] -> Doc #

data TypeMismatch Source #

This error type covers the case where the type of the value does not match.

Constructors

MkTypeMismatch
Fields path :: Path expected :: Type matcher :: Matcher Value given :: Value

Instances

Instances details

ToJSON TypeMismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: TypeMismatch -> Value # toEncoding :: TypeMismatch -> Encoding # toJSONList :: [TypeMismatch] -> Value # toEncodingList :: [TypeMismatch] -> Encoding #
Show TypeMismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> TypeMismatch -> ShowS # show :: TypeMismatch -> String # showList :: [TypeMismatch] -> ShowS #
Eq TypeMismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: TypeMismatch -> TypeMismatch -> Bool # (/=) :: TypeMismatch -> TypeMismatch -> Bool #
Pretty TypeMismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> TypeMismatch -> Doc # pPrint :: TypeMismatch -> Doc # pPrintList :: PrettyLevel -> [TypeMismatch] -> Doc #

data Mismatch Source #

This error type covers the case where the type matches but the value does not.

Constructors

MkMismatch
Fields path :: Path matcher :: Matcher Value given :: Value

Instances

Instances details

ToJSON Mismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: Mismatch -> Value # toEncoding :: Mismatch -> Encoding # toJSONList :: [Mismatch] -> Value # toEncodingList :: [Mismatch] -> Encoding #
Show Mismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> Mismatch -> ShowS # show :: Mismatch -> String # showList :: [Mismatch] -> ShowS #
Eq Mismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: Mismatch -> Mismatch -> Bool # (/=) :: Mismatch -> Mismatch -> Bool #
Pretty Mismatch Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> Mismatch -> Doc # pPrint :: Mismatch -> Doc # pPrintList :: PrettyLevel -> [Mismatch] -> Doc #

data MissingPathElem Source #

This error type covers the case where the requested path simply does not exist in a Value.

Constructors

MkMissingPathElem
Fields path :: Path missing :: PathElem

Instances

Instances details

ToJSON MissingPathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: MissingPathElem -> Value # toEncoding :: MissingPathElem -> Encoding # toJSONList :: [MissingPathElem] -> Value # toEncodingList :: [MissingPathElem] -> Encoding #
Show MissingPathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> MissingPathElem -> ShowS # show :: MissingPathElem -> String # showList :: [MissingPathElem] -> ShowS #
Eq MissingPathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: MissingPathElem -> MissingPathElem -> Bool # (/=) :: MissingPathElem -> MissingPathElem -> Bool #
Pretty MissingPathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> MissingPathElem -> Doc # pPrint :: MissingPathElem -> Doc # pPrintList :: PrettyLevel -> [MissingPathElem] -> Doc #

data ExtraArrayValues Source #

Unless an permissive matcher is used, any extra values in an array missing in the matcher will trigger this error.

Constructors

MkExtraArrayValues
Fields path :: Path values :: Vector Value

Instances

Instances details

ToJSON ExtraArrayValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: ExtraArrayValues -> Value # toEncoding :: ExtraArrayValues -> Encoding # toJSONList :: [ExtraArrayValues] -> Value # toEncodingList :: [ExtraArrayValues] -> Encoding #
Show ExtraArrayValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> ExtraArrayValues -> ShowS # show :: ExtraArrayValues -> String # showList :: [ExtraArrayValues] -> ShowS #
Eq ExtraArrayValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: ExtraArrayValues -> ExtraArrayValues -> Bool # (/=) :: ExtraArrayValues -> ExtraArrayValues -> Bool #
Pretty ExtraArrayValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> ExtraArrayValues -> Doc # pPrint :: ExtraArrayValues -> Doc # pPrintList :: PrettyLevel -> [ExtraArrayValues] -> Doc #

data ExtraObjectValues Source #

Unless an permissive matcher is used, any extra key-value pairs in an object missing in the matcher will trigger this error.

Constructors

MkExtraObjectValues
Fields path :: Path values :: HashMap Text Value

Instances

Instances details

ToJSON ExtraObjectValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: ExtraObjectValues -> Value # toEncoding :: ExtraObjectValues -> Encoding # toJSONList :: [ExtraObjectValues] -> Value # toEncodingList :: [ExtraObjectValues] -> Encoding #
Show ExtraObjectValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> ExtraObjectValues -> ShowS # show :: ExtraObjectValues -> String # showList :: [ExtraObjectValues] -> ShowS #
Eq ExtraObjectValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: ExtraObjectValues -> ExtraObjectValues -> Bool # (/=) :: ExtraObjectValues -> ExtraObjectValues -> Bool #
Pretty ExtraObjectValues Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> ExtraObjectValues -> Doc # pPrint :: ExtraObjectValues -> Doc # pPrintList :: PrettyLevel -> [ExtraObjectValues] -> Doc #

prettyError :: Error -> String Source #

Pretty print an Error.

data Matcher ext Source #

A value constructed using qq that attempts to match a JSON document.

Constructors

Hole (Maybe HoleSig) (Maybe Text)	Optionally typed, optionally named _hole. If a type is provided, the _hole only matches those values that have that type. If a name is provided, the matched value is returned to the user.
Null
Bool Bool
Number Scientific
String Text
StringCI (CI Text)	Case-insensitive strings
Array (Array ext)
ArrayUO (Array ext)	Unordered arrays
Object (Object ext)
Ext ext	External values spliced into a `Matcher` using the `#{}` syntax

Instances

Instances details

Functor Matcher Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods fmap :: (a -> b) -> Matcher a -> Matcher b # (<$) :: a -> Matcher b -> Matcher a #
ToJSON ext => ToJSON (Matcher ext) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods toJSON :: Matcher ext -> Value # toEncoding :: Matcher ext -> Encoding # toJSONList :: [Matcher ext] -> Value # toEncodingList :: [Matcher ext] -> Encoding #
Show ext => Show (Matcher ext) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods showsPrec :: Int -> Matcher ext -> ShowS # show :: Matcher ext -> String # showList :: [Matcher ext] -> ShowS #
Eq ext => Eq (Matcher ext) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods (==) :: Matcher ext -> Matcher ext -> Bool # (/=) :: Matcher ext -> Matcher ext -> Bool #

type Array ext = Box (Vector (Matcher ext)) Source #

type Object ext = Box (HashMap Text (Matcher ext)) Source #

data Box a Source #

A wrapper for those matchers that support the ... syntax.

Constructors

Box
Fields values :: a extra :: Bool Are extra, not specifically mentioned by a `Matcher`, values allowed in a `Value`?

Instances

Instances details

Functor Box Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods fmap :: (a -> b) -> Box a -> Box b # (<$) :: a -> Box b -> Box a #
ToJSON a => ToJSON (Box a) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods toJSON :: Box a -> Value # toEncoding :: Box a -> Encoding # toJSONList :: [Box a] -> Value # toEncodingList :: [Box a] -> Encoding #
Show a => Show (Box a) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods showsPrec :: Int -> Box a -> ShowS # show :: Box a -> String # showList :: [Box a] -> ShowS #
Eq a => Eq (Box a) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods (==) :: Box a -> Box a -> Bool # (/=) :: Box a -> Box a -> Bool #

data HoleSig Source #

_hole type signature

Constructors

HoleSig
Fields type_ :: Type nullable :: Bool

Instances

Instances details

ToJSON HoleSig Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods toJSON :: HoleSig -> Value # toEncoding :: HoleSig -> Encoding # toJSONList :: [HoleSig] -> Value # toEncodingList :: [HoleSig] -> Encoding #
Show HoleSig Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods showsPrec :: Int -> HoleSig -> ShowS # show :: HoleSig -> String # showList :: [HoleSig] -> ShowS #
Eq HoleSig Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods (==) :: HoleSig -> HoleSig -> Bool # (/=) :: HoleSig -> HoleSig -> Bool #
Lift HoleSig Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods lift :: Quote m => HoleSig -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => HoleSig -> Code m HoleSig #

data Type Source #

_hole type

Constructors

BoolT	_ : bool
NumberT	_ : number
StringT	_ : string
StringCIT	_ : ci-string
ArrayT	_ : array
ArrayUOT	_ : unordered-array
ObjectT	_ : object

Instances

Instances details

ToJSON Type Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods toJSON :: Type -> Value # toEncoding :: Type -> Encoding # toJSONList :: [Type] -> Value # toEncodingList :: [Type] -> Encoding #
Show Type Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #
Eq Type Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #
Pretty Type Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods pPrintPrec :: PrettyLevel -> Rational -> Type -> Doc # pPrint :: Type -> Doc # pPrintList :: PrettyLevel -> [Type] -> Doc #
Lift Type Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods lift :: Quote m => Type -> m Exp # liftTyped :: forall (m :: Type0 -> Type0). Quote m => Type -> Code m Type #

newtype Path Source #

A path is a list of path elements.

Constructors

Path
Fields unPath :: [PathElem]

Instances

Instances details

ToJSON Path Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: Path -> Value # toEncoding :: Path -> Encoding # toJSONList :: [Path] -> Value # toEncodingList :: [Path] -> Encoding #
IsList Path Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Associated Types type Item Path # Methods fromList :: [Item Path] -> Path # fromListN :: Int -> [Item Path] -> Path # toList :: Path -> [Item Path] #
Show Path Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
Eq Path Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Pretty Path Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> Path -> Doc # pPrint :: Path -> Doc # pPrintList :: PrettyLevel -> [Path] -> Doc #
type Item Path Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match type Item Path = Item [PathElem]

data PathElem Source #

A path element is either a key lookup in an object, or an index lookup in an array.

Constructors

Key Text
Idx Int

Instances

Instances details

ToJSON PathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods toJSON :: PathElem -> Value # toEncoding :: PathElem -> Encoding # toJSONList :: [PathElem] -> Value # toEncodingList :: [PathElem] -> Encoding #
IsString PathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods fromString :: String -> PathElem #
Show PathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods showsPrec :: Int -> PathElem -> ShowS # show :: PathElem -> String # showList :: [PathElem] -> ShowS #
Eq PathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods (==) :: PathElem -> PathElem -> Bool # (/=) :: PathElem -> PathElem -> Bool #
Pretty PathElem Source #
Instance details Defined in Aeson.Match.QQ.Internal.Match Methods pPrintPrec :: PrettyLevel -> Rational -> PathElem -> Doc # pPrint :: PathElem -> Doc # pPrintList :: PrettyLevel -> [PathElem] -> Doc #

parse :: ByteString -> Either String (Matcher Exp) Source #

An attoparsec parser for a Matcher.

Note: consumes spaces before and after the matcher.