Safe Haskell	Safe-Inferred
Language	Haskell2010

Aeson.Match.QQ.Internal.Match

Synopsis

match :: Matcher Value -> Value -> Either (NonEmpty Error) (HashMap Text Value)
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
}
newtype Path = Path {
- unPath :: [PathElem]
}
data PathElem
- = Key Text
- | Idx Int

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.

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 #

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 #