Copyright	(c) 2024-2025 Taimoor Zaeem
License	MIT
Maintainer	Taimoor Zaeem <mtaimoorzaeem@gmail.com>
Stability	Experimental
Portability	Portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.Aeson.JSONPath.Types

Description

This module contains all the data structures related to JSONPath

Synopsis

data Query = Query {
- queryType :: QueryType
- querySegments :: [QuerySegment Query]
}
data QueryType
- = Root
- | Current
data QueryState = QueryState {
- rootVal :: Value
- curVal :: Value
- executeQuery :: Query -> QueryState -> Vector Value
}
data Segment a
- = Bracketed [Selector a]
- | Dotted Text
- | WildcardSegment
data QuerySegment a = QuerySegment {
- segmentType :: SegmentType
- segment :: Segment a
}
data SegmentType
- = Child
- | Descendant
data Selector a
- = Name Text
- | Index Int
- | ArraySlice (Maybe Int, Maybe Int, Int)
- | Filter (LogicalOrExpr a)
- | WildcardSelector
newtype LogicalOrExpr a = LogicalOr [LogicalAndExpr a]
newtype LogicalAndExpr a = LogicalAnd [BasicExpr a]
data BasicExpr a
- = Paren (LogicalOrExpr a)
- | NotParen (LogicalOrExpr a)
- | Test (TestExpr a)
- | NotTest (TestExpr a)
- | Comparison ComparisonExpr
newtype TestExpr a = FilterQuery a
data ComparisonExpr = Comp Comparable ComparisonOp Comparable
data ComparisonOp
- = Less
- | LessOrEqual
- | Greater
- | GreaterOrEqual
- | Equal
- | NotEqual
data Comparable
- = CompLit Literal
- | CompSQ SingularQuery
data Literal
- = LitString Text
- | LitNum Scientific
- | LitBool Bool
- | LitNull
data SingularQueryType
- = RootSQ
- | CurrentSQ
data SingularQuery = SingularQuery {
- singularQueryType :: SingularQueryType
- singularQuerySegments :: [SingularQuerySegment]
}
data SingularQuerySegment
- = NameSQSeg Text
- | IndexSQSeg Int

Documentation

data Query Source #

Constructors

Query
Fields queryType :: QueryType querySegments :: [QuerySegment Query]

Instances

Instances details

Show Query Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Query Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
Eq Query Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Query Methods (==) :: Query -> Query -> Bool # (/=) :: Query -> Query -> Bool #
Lift Query Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Query Methods lift :: Quote m => Query -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Query -> Code m Query #

data QueryType Source #

Constructors

Root
Current

Instances

Instances details

Show QueryType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Query Methods showsPrec :: Int -> QueryType -> ShowS # show :: QueryType -> String # showList :: [QueryType] -> ShowS #
Eq QueryType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Query Methods (==) :: QueryType -> QueryType -> Bool # (/=) :: QueryType -> QueryType -> Bool #
Lift QueryType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Query Methods lift :: Quote m => QueryType -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => QueryType -> Code m QueryType #

data QueryState Source #

Constructors

QueryState
Fields rootVal :: Value curVal :: Value executeQuery :: Query -> QueryState -> Vector Value

data Segment a Source #

Constructors

Bracketed [Selector a]
Dotted Text
WildcardSegment

Instances

Instances details

Lift a => Lift (Segment a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods lift :: Quote m => Segment a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Segment a -> Code m (Segment a) #
Show a => Show (Segment a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods showsPrec :: Int -> Segment a -> ShowS # show :: Segment a -> String # showList :: [Segment a] -> ShowS #
Eq a => Eq (Segment a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods (==) :: Segment a -> Segment a -> Bool # (/=) :: Segment a -> Segment a -> Bool #

data QuerySegment a Source #

Constructors

QuerySegment
Fields segmentType :: SegmentType segment :: Segment a

Instances

Instances details

Lift a => Lift (QuerySegment a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods lift :: Quote m => QuerySegment a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => QuerySegment a -> Code m (QuerySegment a) #
Show a => Show (QuerySegment a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods showsPrec :: Int -> QuerySegment a -> ShowS # show :: QuerySegment a -> String # showList :: [QuerySegment a] -> ShowS #
Eq a => Eq (QuerySegment a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods (==) :: QuerySegment a -> QuerySegment a -> Bool # (/=) :: QuerySegment a -> QuerySegment a -> Bool #

data SegmentType Source #

Constructors

Child
Descendant

Instances

Instances details

Show SegmentType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods showsPrec :: Int -> SegmentType -> ShowS # show :: SegmentType -> String # showList :: [SegmentType] -> ShowS #
Eq SegmentType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods (==) :: SegmentType -> SegmentType -> Bool # (/=) :: SegmentType -> SegmentType -> Bool #
Lift SegmentType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Segment Methods lift :: Quote m => SegmentType -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => SegmentType -> Code m SegmentType #

data Selector a Source #

Constructors

Name Text
Index Int
ArraySlice (Maybe Int, Maybe Int, Int)
Filter (LogicalOrExpr a)
WildcardSelector

Instances

Instances details

Lift a => Lift (Selector a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Selector Methods lift :: Quote m => Selector a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Selector a -> Code m (Selector a) #
Show a => Show (Selector a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Selector Methods showsPrec :: Int -> Selector a -> ShowS # show :: Selector a -> String # showList :: [Selector a] -> ShowS #
Eq a => Eq (Selector a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Selector Methods (==) :: Selector a -> Selector a -> Bool # (/=) :: Selector a -> Selector a -> Bool #

newtype LogicalOrExpr a Source #

Constructors

LogicalOr [LogicalAndExpr a]

Instances

Instances details

Lift a => Lift (LogicalOrExpr a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => LogicalOrExpr a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => LogicalOrExpr a -> Code m (LogicalOrExpr a) #
Show a => Show (LogicalOrExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> LogicalOrExpr a -> ShowS # show :: LogicalOrExpr a -> String # showList :: [LogicalOrExpr a] -> ShowS #
Eq a => Eq (LogicalOrExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: LogicalOrExpr a -> LogicalOrExpr a -> Bool # (/=) :: LogicalOrExpr a -> LogicalOrExpr a -> Bool #

newtype LogicalAndExpr a Source #

Constructors

LogicalAnd [BasicExpr a]

Instances

Instances details

Lift a => Lift (LogicalAndExpr a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => LogicalAndExpr a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => LogicalAndExpr a -> Code m (LogicalAndExpr a) #
Show a => Show (LogicalAndExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> LogicalAndExpr a -> ShowS # show :: LogicalAndExpr a -> String # showList :: [LogicalAndExpr a] -> ShowS #
Eq a => Eq (LogicalAndExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: LogicalAndExpr a -> LogicalAndExpr a -> Bool # (/=) :: LogicalAndExpr a -> LogicalAndExpr a -> Bool #

data BasicExpr a Source #

Constructors

Paren (LogicalOrExpr a)
NotParen (LogicalOrExpr a)
Test (TestExpr a)
NotTest (TestExpr a)
Comparison ComparisonExpr

Instances

Instances details

Lift a => Lift (BasicExpr a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => BasicExpr a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => BasicExpr a -> Code m (BasicExpr a) #
Show a => Show (BasicExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> BasicExpr a -> ShowS # show :: BasicExpr a -> String # showList :: [BasicExpr a] -> ShowS #
Eq a => Eq (BasicExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: BasicExpr a -> BasicExpr a -> Bool # (/=) :: BasicExpr a -> BasicExpr a -> Bool #

newtype TestExpr a Source #

Constructors

FilterQuery a

Instances

Instances details

Lift a => Lift (TestExpr a :: Type) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => TestExpr a -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => TestExpr a -> Code m (TestExpr a) #
Show a => Show (TestExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> TestExpr a -> ShowS # show :: TestExpr a -> String # showList :: [TestExpr a] -> ShowS #
Eq a => Eq (TestExpr a) Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: TestExpr a -> TestExpr a -> Bool # (/=) :: TestExpr a -> TestExpr a -> Bool #

data ComparisonExpr Source #

Constructors

Comp Comparable ComparisonOp Comparable

Instances

Instances details

Show ComparisonExpr Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> ComparisonExpr -> ShowS # show :: ComparisonExpr -> String # showList :: [ComparisonExpr] -> ShowS #
Eq ComparisonExpr Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: ComparisonExpr -> ComparisonExpr -> Bool # (/=) :: ComparisonExpr -> ComparisonExpr -> Bool #
Lift ComparisonExpr Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => ComparisonExpr -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ComparisonExpr -> Code m ComparisonExpr #

data ComparisonOp Source #

Constructors

Less
LessOrEqual
Greater
GreaterOrEqual
Equal
NotEqual

Instances

Instances details

Show ComparisonOp Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> ComparisonOp -> ShowS # show :: ComparisonOp -> String # showList :: [ComparisonOp] -> ShowS #
Eq ComparisonOp Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: ComparisonOp -> ComparisonOp -> Bool # (/=) :: ComparisonOp -> ComparisonOp -> Bool #
Lift ComparisonOp Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => ComparisonOp -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => ComparisonOp -> Code m ComparisonOp #

data Comparable Source #

Constructors

CompLit Literal
CompSQ SingularQuery

Instances

Instances details

Show Comparable Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> Comparable -> ShowS # show :: Comparable -> String # showList :: [Comparable] -> ShowS #
Eq Comparable Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: Comparable -> Comparable -> Bool # (/=) :: Comparable -> Comparable -> Bool #
Lift Comparable Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => Comparable -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Comparable -> Code m Comparable #

data Literal Source #

Constructors

LitString Text
LitNum Scientific
LitBool Bool
LitNull

Instances

Instances details

Show Literal Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> Literal -> ShowS # show :: Literal -> String # showList :: [Literal] -> ShowS #
Eq Literal Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: Literal -> Literal -> Bool # (/=) :: Literal -> Literal -> Bool #
Lift Literal Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => Literal -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Literal -> Code m Literal #

data SingularQueryType Source #

Constructors

RootSQ
CurrentSQ

Instances

Instances details

Show SingularQueryType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> SingularQueryType -> ShowS # show :: SingularQueryType -> String # showList :: [SingularQueryType] -> ShowS #
Eq SingularQueryType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: SingularQueryType -> SingularQueryType -> Bool # (/=) :: SingularQueryType -> SingularQueryType -> Bool #
Lift SingularQueryType Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => SingularQueryType -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => SingularQueryType -> Code m SingularQueryType #

data SingularQuery Source #

Constructors

SingularQuery
Fields singularQueryType :: SingularQueryType singularQuerySegments :: [SingularQuerySegment]

Instances

Instances details

Show SingularQuery Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> SingularQuery -> ShowS # show :: SingularQuery -> String # showList :: [SingularQuery] -> ShowS #
Eq SingularQuery Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: SingularQuery -> SingularQuery -> Bool # (/=) :: SingularQuery -> SingularQuery -> Bool #
Lift SingularQuery Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => SingularQuery -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => SingularQuery -> Code m SingularQuery #

data SingularQuerySegment Source #

Constructors

NameSQSeg Text
IndexSQSeg Int

Instances

Instances details

Show SingularQuerySegment Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods showsPrec :: Int -> SingularQuerySegment -> ShowS # show :: SingularQuerySegment -> String # showList :: [SingularQuerySegment] -> ShowS #
Eq SingularQuerySegment Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods (==) :: SingularQuerySegment -> SingularQuerySegment -> Bool # (/=) :: SingularQuerySegment -> SingularQuerySegment -> Bool #
Lift SingularQuerySegment Source #
Instance details Defined in Data.Aeson.JSONPath.Types.Filter Methods lift :: Quote m => SingularQuerySegment -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => SingularQuerySegment -> Code m SingularQuerySegment #