Safe Haskell	Safe-Inferred
Language	Haskell2010

Aeson.Match.QQ

Synopsis

match :: Value Value -> Value -> Either (NonEmpty Error) (HashMap Text Value)
qq :: QuasiQuoter
data Error
data Mismatch = MkMismatch {
- path :: Path
- matcher :: Value 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
}
data Value ext
- = Any (Maybe TypeSig) (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 (Value ext))
type Object ext = Box (HashMap Text (Value ext))
data Box a = Box {
- knownValues :: a
- extendable :: Bool
}
data TypeSig = TypeSig {
- type_ :: Type
- nullable :: Nullable
}
data Type
- = BoolT
- | NumberT
- | StringT
- | StringCIT
- | ArrayT
- | ArrayUOT
- | ObjectT
data Nullable
- = Nullable
- | NonNullable
newtype Path = Path {
- unPath :: [PathElem]
}
data PathElem
- = Key Text
- | Idx Int
prettyError :: Error -> String

Documentation

match Source #

Arguments

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

Test if a matcher matches a Value.

qq :: QuasiQuoter Source #

Construct a matcher Value.

data Error Source #

Constructors

Mismatch Mismatch
Mistype Mismatch
MissingPathElem MissingPathElem
ExtraArrayValues ExtraArrayValues
ExtraObjectValues ExtraObjectValues

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 Mismatch Source #

Constructors

MkMismatch
Fields path :: Path matcher :: Value 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 #

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 #

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 #

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 #

data Value ext Source #

Constructors

Any (Maybe TypeSig) (Maybe Text)
Null
Bool Bool
Number Scientific
String Text
StringCI (CI Text)
Array (Array ext)
ArrayUO (Array ext)
Object (Object ext)
Ext ext

Instances

Instances details

ext ~ Exp => Lift (Value ext :: Type) Source #	Convert `Value Exp` to `Value Aeson.Value`. This uses a roundabout way to get `Value` from `toEncoding` to avoid calling `toJSON` which may be undefined for some datatypes.
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods lift :: Quote m => Value ext -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Value ext -> Code m (Value ext) #
ToJSON ext => ToJSON (Value ext) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods toJSON :: Value ext -> Value0 # toEncoding :: Value ext -> Encoding # toJSONList :: [Value ext] -> Value0 # toEncodingList :: [Value ext] -> Encoding #
Show ext => Show (Value ext) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods showsPrec :: Int -> Value ext -> ShowS # show :: Value ext -> String # showList :: [Value ext] -> ShowS #
Eq ext => Eq (Value ext) Source #
Instance details Defined in Aeson.Match.QQ.Internal.Value Methods (==) :: Value ext -> Value ext -> Bool # (/=) :: Value ext -> Value ext -> Bool #

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

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

data Box a Source #

Constructors

Box
Fields knownValues :: a extendable :: Bool

Instances

Instances details

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 TypeSig Source #

Constructors

TypeSig
Fields type_ :: Type nullable :: Nullable

Instances

Instances details

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

data Type Source #

Constructors

BoolT
NumberT
StringT
StringCIT
ArrayT
ArrayUOT
ObjectT

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 #
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 #

data Nullable Source #

Constructors

Nullable
NonNullable

Instances

Instances details

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

newtype Path Source #

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 #

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 #

prettyError :: Error -> String Source #

Pretty print an Error.