Aeson.Match.QQ

Documentation

match

Arguments

:: Value Value

A matcher, constructed with qq

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

Construct a matcher Value.

data Error

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 Mismatch

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

ToJSON Error

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: Error -> Value

toEncoding :: Error -> Encoding

toJSONList :: [Error] -> Value

toEncodingList :: [Error] -> Encoding

Show Error

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

Eq Error

Defined in Aeson.Match.QQ.Internal.Match

Methods

(==) :: Error -> Error -> Bool

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

Pretty Error

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> Error -> Doc

pPrint :: Error -> Doc

pPrintList :: PrettyLevel -> [Error] -> Doc

data Mismatch

A generic error that covers cases where either the type of the value is wrong, or the value itself does not match.

Constructors

MkMismatch

Fields

• path :: Path
• matcher :: Value Value
• given :: Value

Instances

ToJSON Mismatch

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: Mismatch -> Value

toEncoding :: Mismatch -> Encoding

toJSONList :: [Mismatch] -> Value

toEncodingList :: [Mismatch] -> Encoding

Show Mismatch

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> Mismatch -> ShowS

show :: Mismatch -> String

showList :: [Mismatch] -> ShowS

Eq Mismatch

Defined in Aeson.Match.QQ.Internal.Match

Methods

(==) :: Mismatch -> Mismatch -> Bool

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

Pretty Mismatch

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> Mismatch -> Doc

pPrint :: Mismatch -> Doc

pPrintList :: PrettyLevel -> [Mismatch] -> Doc

data MissingPathElem

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

Constructors

MkMissingPathElem

Fields

• path :: Path
• missing :: PathElem

Instances

ToJSON MissingPathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: MissingPathElem -> Value

toEncoding :: MissingPathElem -> Encoding

toJSONList :: [MissingPathElem] -> Value

toEncodingList :: [MissingPathElem] -> Encoding

Show MissingPathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> MissingPathElem -> ShowS

show :: MissingPathElem -> String

showList :: [MissingPathElem] -> ShowS

Eq MissingPathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

(==) :: MissingPathElem -> MissingPathElem -> Bool

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

Pretty MissingPathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> MissingPathElem -> Doc

pPrint :: MissingPathElem -> Doc

pPrintList :: PrettyLevel -> [MissingPathElem] -> Doc

data ExtraArrayValues

Unless an extendable 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

ToJSON ExtraArrayValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: ExtraArrayValues -> Value

toEncoding :: ExtraArrayValues -> Encoding

toJSONList :: [ExtraArrayValues] -> Value

toEncodingList :: [ExtraArrayValues] -> Encoding

Show ExtraArrayValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> ExtraArrayValues -> ShowS

show :: ExtraArrayValues -> String

showList :: [ExtraArrayValues] -> ShowS

Eq ExtraArrayValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

(==) :: ExtraArrayValues -> ExtraArrayValues -> Bool

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

Pretty ExtraArrayValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> ExtraArrayValues -> Doc

pPrint :: ExtraArrayValues -> Doc

pPrintList :: PrettyLevel -> [ExtraArrayValues] -> Doc

data ExtraObjectValues

Unless an extendable 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

ToJSON ExtraObjectValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: ExtraObjectValues -> Value

toEncoding :: ExtraObjectValues -> Encoding

toJSONList :: [ExtraObjectValues] -> Value

toEncodingList :: [ExtraObjectValues] -> Encoding

Show ExtraObjectValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> ExtraObjectValues -> ShowS

show :: ExtraObjectValues -> String

showList :: [ExtraObjectValues] -> ShowS

Eq ExtraObjectValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

(==) :: ExtraObjectValues -> ExtraObjectValues -> Bool

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

Pretty ExtraObjectValues

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> ExtraObjectValues -> Doc

pPrint :: ExtraObjectValues -> Doc

pPrintList :: PrettyLevel -> [ExtraObjectValues] -> Doc

prettyError :: Error -> String

Pretty print an Error.

data Value ext

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

ext ~ Exp => Lift (Value ext :: Type)

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.

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)

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)

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)

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

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

data Box a

Constructors

Box

Fields

• knownValues :: a
• extendable :: Bool

Instances

ToJSON a => ToJSON (Box a)

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)

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)

Defined in Aeson.Match.QQ.Internal.Value

Methods

(==) :: Box a -> Box a -> Bool

(/=) :: Box a -> Box a -> Bool

data TypeSig

Constructors

TypeSig

Fields

• type_ :: Type
• nullable :: Nullable

Instances

ToJSON TypeSig

Defined in Aeson.Match.QQ.Internal.Value

Methods

toJSON :: TypeSig -> Value

toEncoding :: TypeSig -> Encoding

toJSONList :: [TypeSig] -> Value

toEncodingList :: [TypeSig] -> Encoding

Show TypeSig

Defined in Aeson.Match.QQ.Internal.Value

Methods

showsPrec :: Int -> TypeSig -> ShowS

show :: TypeSig -> String

showList :: [TypeSig] -> ShowS

Eq TypeSig

Defined in Aeson.Match.QQ.Internal.Value

Methods

(==) :: TypeSig -> TypeSig -> Bool

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

Lift TypeSig

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

Constructors

BoolT

NumberT

StringT

StringCIT

ArrayT

ArrayUOT

ObjectT

Instances

ToJSON Type

Defined in Aeson.Match.QQ.Internal.Value

Methods

toJSON :: Type -> Value

toEncoding :: Type -> Encoding

toJSONList :: [Type] -> Value

toEncodingList :: [Type] -> Encoding

Show Type

Defined in Aeson.Match.QQ.Internal.Value

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

Eq Type

Defined in Aeson.Match.QQ.Internal.Value

Methods

(==) :: Type -> Type -> Bool

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

Lift Type

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

Constructors

Nullable

NonNullable

Instances

ToJSON Nullable

Defined in Aeson.Match.QQ.Internal.Value

Methods

toJSON :: Nullable -> Value

toEncoding :: Nullable -> Encoding

toJSONList :: [Nullable] -> Value

toEncodingList :: [Nullable] -> Encoding

Show Nullable

Defined in Aeson.Match.QQ.Internal.Value

Methods

showsPrec :: Int -> Nullable -> ShowS

show :: Nullable -> String

showList :: [Nullable] -> ShowS

Eq Nullable

Defined in Aeson.Match.QQ.Internal.Value

Methods

(==) :: Nullable -> Nullable -> Bool

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

Lift Nullable

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

A path is a list of path elements.

Constructors

Path

Fields

• unPath :: [PathElem]

Instances

ToJSON Path

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: Path -> Value

toEncoding :: Path -> Encoding

toJSONList :: [Path] -> Value

toEncodingList :: [Path] -> Encoding

IsList Path

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

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

Eq Path

Defined in Aeson.Match.QQ.Internal.Match

Methods

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

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

Pretty Path

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> Path -> Doc

pPrint :: Path -> Doc

pPrintList :: PrettyLevel -> [Path] -> Doc

type Item Path

Defined in Aeson.Match.QQ.Internal.Match

type Item Path = Item [PathElem]

data PathElem

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

Constructors

Key Text

Idx Int

Instances

ToJSON PathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

toJSON :: PathElem -> Value

toEncoding :: PathElem -> Encoding

toJSONList :: [PathElem] -> Value

toEncodingList :: [PathElem] -> Encoding

IsString PathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

fromString :: String -> PathElem

Show PathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

showsPrec :: Int -> PathElem -> ShowS

show :: PathElem -> String

showList :: [PathElem] -> ShowS

Eq PathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

(==) :: PathElem -> PathElem -> Bool

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

Pretty PathElem

Defined in Aeson.Match.QQ.Internal.Match

Methods

pPrintPrec :: PrettyLevel -> Rational -> PathElem -> Doc

pPrint :: PathElem -> Doc

pPrintList :: PrettyLevel -> [PathElem] -> Doc