Jordan.Servant.Query.Parse

Turn your jordan parsers into query-string parsers.

This module should be considered internal. Import Jordan.Servant.Query instead.

Documentation

data QueryKeyComponent

Constructors

RawValue Text

EmptyBraces

BracedValue Text

Instances

Eq QueryKeyComponent

Defined in Jordan.Servant.Query.Parse

Methods

(==) :: QueryKeyComponent -> QueryKeyComponent -> Bool

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

Ord QueryKeyComponent

Defined in Jordan.Servant.Query.Parse

Methods

compare :: QueryKeyComponent -> QueryKeyComponent -> Ordering

(<) :: QueryKeyComponent -> QueryKeyComponent -> Bool

(<=) :: QueryKeyComponent -> QueryKeyComponent -> Bool

(>) :: QueryKeyComponent -> QueryKeyComponent -> Bool

(>=) :: QueryKeyComponent -> QueryKeyComponent -> Bool

max :: QueryKeyComponent -> QueryKeyComponent -> QueryKeyComponent

min :: QueryKeyComponent -> QueryKeyComponent -> QueryKeyComponent

Read QueryKeyComponent

Defined in Jordan.Servant.Query.Parse

Methods

readsPrec :: Int -> ReadS QueryKeyComponent

readList :: ReadS [QueryKeyComponent]

readPrec :: ReadPrec QueryKeyComponent

readListPrec :: ReadPrec [QueryKeyComponent]

Show QueryKeyComponent

Defined in Jordan.Servant.Query.Parse

Methods

showsPrec :: Int -> QueryKeyComponent -> ShowS

show :: QueryKeyComponent -> String

showList :: [QueryKeyComponent] -> ShowS

Generic QueryKeyComponent

Defined in Jordan.Servant.Query.Parse

Associated Types

type Rep QueryKeyComponent :: Type -> Type

Methods

from :: QueryKeyComponent -> Rep QueryKeyComponent x

to :: Rep QueryKeyComponent x -> QueryKeyComponent

type Rep QueryKeyComponent

Defined in Jordan.Servant.Query.Parse

type Rep QueryKeyComponent = D1 ('MetaData "QueryKeyComponent" "Jordan.Servant.Query.Parse" "jordan-servant-0.1.0.0-4pWi47ZOJ6bHDVnhgja79c" 'False) (C1 ('MetaCons "RawValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "EmptyBraces" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BracedValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

newtype QueryKey

Constructors

QueryKey

Fields

• queryKeyComponents :: [QueryKeyComponent]

Instances

Eq QueryKey

Defined in Jordan.Servant.Query.Parse

Methods

(==) :: QueryKey -> QueryKey -> Bool

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

Ord QueryKey

Defined in Jordan.Servant.Query.Parse

Methods

compare :: QueryKey -> QueryKey -> Ordering

(<) :: QueryKey -> QueryKey -> Bool

(<=) :: QueryKey -> QueryKey -> Bool

(>) :: QueryKey -> QueryKey -> Bool

(>=) :: QueryKey -> QueryKey -> Bool

max :: QueryKey -> QueryKey -> QueryKey

min :: QueryKey -> QueryKey -> QueryKey

Read QueryKey

Defined in Jordan.Servant.Query.Parse

Methods

readsPrec :: Int -> ReadS QueryKey

readList :: ReadS [QueryKey]

readPrec :: ReadPrec QueryKey

readListPrec :: ReadPrec [QueryKey]

Show QueryKey

Defined in Jordan.Servant.Query.Parse

Methods

showsPrec :: Int -> QueryKey -> ShowS

show :: QueryKey -> String

showList :: [QueryKey] -> ShowS

Generic QueryKey

Defined in Jordan.Servant.Query.Parse

Associated Types

type Rep QueryKey :: Type -> Type

Methods

from :: QueryKey -> Rep QueryKey x

to :: Rep QueryKey x -> QueryKey

type Rep QueryKey

Defined in Jordan.Servant.Query.Parse

type Rep QueryKey = D1 ('MetaData "QueryKey" "Jordan.Servant.Query.Parse" "jordan-servant-0.1.0.0-4pWi47ZOJ6bHDVnhgja79c" 'True) (C1 ('MetaCons "QueryKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryKeyComponents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [QueryKeyComponent])))

labelParser :: Parser i a -> String -> Parser i a

escapedBrace :: Parser ByteString

afterBrace :: Parser ByteString

escapedBraceEnding :: Parser ByteString

unbracedValueInner :: Parser ByteString

unbracedValue :: Parser Text

bracedValue :: Parser Text

emptyBraces :: Parser ByteString QueryKeyComponent

queryComponent :: Parser QueryKeyComponent

parseQueryKey :: Parser QueryKey

newtype QueryParser a

Constructors

QueryParser

Fields

• runQueryParser :: (QueryKey -> Maybe QueryKey) -> [(QueryKey, Maybe ByteString)] -> Either String (a, [(QueryKey, Maybe ByteString)])

Instances

Monad QueryParser

Defined in Jordan.Servant.Query.Parse

Methods

(>>=) :: QueryParser a -> (a -> QueryParser b) -> QueryParser b

(>>) :: QueryParser a -> QueryParser b -> QueryParser b

return :: a -> QueryParser a

Functor QueryParser

Defined in Jordan.Servant.Query.Parse

Methods

fmap :: (a -> b) -> QueryParser a -> QueryParser b

(<$) :: a -> QueryParser b -> QueryParser a

Applicative QueryParser

Defined in Jordan.Servant.Query.Parse

Methods

pure :: a -> QueryParser a

(<*>) :: QueryParser (a -> b) -> QueryParser a -> QueryParser b

liftA2 :: (a -> b -> c) -> QueryParser a -> QueryParser b -> QueryParser c

(*>) :: QueryParser a -> QueryParser b -> QueryParser b

(<*) :: QueryParser a -> QueryParser b -> QueryParser a

Alternative QueryParser

Alternative tries the left, than the right.

Both brances will be sparked off and tried in parallel.

Defined in Jordan.Servant.Query.Parse

Methods

empty :: QueryParser a

(<|>) :: QueryParser a -> QueryParser a -> QueryParser a

some :: QueryParser a -> QueryParser [a]

many :: QueryParser a -> QueryParser [a]

peekTransformedKeyHead :: QueryParser QueryKey

readBracketKey :: QueryKey -> QueryParser (Text, QueryKeyComponent)

modifyTransformed :: (QueryKey -> Maybe QueryKey) -> QueryParser a -> QueryParser a

droppingItem :: QueryKeyComponent -> QueryParser a -> QueryParser a

droppingFirst :: QueryParser a -> QueryParser a

asTuple :: QueryParser a -> QueryParser (Text, a)

getTransform :: QueryParser (QueryKey -> Maybe QueryKey)

failParse :: String -> QueryParser a

takeValue :: QueryParser (Maybe ByteString)

Take the value at the head, ensuring along the way that the entire query matches.

takeElement :: QueryParser ByteString

takeNull :: QueryParser ()

orParseError :: Show err => QueryParser (Either err a) -> QueryParser a

ensureConsumes :: QueryParser a -> QueryParser a

newtype JordanQueryParser a

Constructors

JordanQueryParser

Fields

• runJordanQueryParser :: QueryParser a

Instances

Functor JordanQueryParser

Defined in Jordan.Servant.Query.Parse

Methods

fmap :: (a -> b) -> JordanQueryParser a -> JordanQueryParser b

(<$) :: a -> JordanQueryParser b -> JordanQueryParser a

Applicative JordanQueryParser

Defined in Jordan.Servant.Query.Parse

Methods

pure :: a -> JordanQueryParser a

(<*>) :: JordanQueryParser (a -> b) -> JordanQueryParser a -> JordanQueryParser b

liftA2 :: (a -> b -> c) -> JordanQueryParser a -> JordanQueryParser b -> JordanQueryParser c

(*>) :: JordanQueryParser a -> JordanQueryParser b -> JordanQueryParser b

(<*) :: JordanQueryParser a -> JordanQueryParser b -> JordanQueryParser a

JSONTupleParser JordanQueryParser

Defined in Jordan.Servant.Query.Parse

Methods

consumeItemWith :: (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> JordanQueryParser a

consumeItem :: FromJSON v => JordanQueryParser v

JSONParser JordanQueryParser

Defined in Jordan.Servant.Query.Parse

Methods

parseObject :: (forall (objectParser :: Type -> Type). JSONObjectParser objectParser => objectParser a) -> JordanQueryParser a

parseObjectStrict :: (forall (objectParser :: Type -> Type). JSONObjectParser objectParser => objectParser a) -> JordanQueryParser a

parseDictionary :: (forall (jsonParser :: Type -> Type). JSONParser jsonParser => jsonParser a) -> JordanQueryParser [(Text, a)]

parseText :: JordanQueryParser Text

parseTextConstant :: Text -> JordanQueryParser ()

parseTuple :: (forall (arrayParser :: Type -> Type). JSONTupleParser arrayParser => arrayParser o) -> JordanQueryParser o

parseArray :: FromJSON a => JordanQueryParser [a]

parseArrayWith :: (forall (jsonParser :: Type -> Type). JSONParser jsonParser => jsonParser a) -> JordanQueryParser [a]

parseNumber :: JordanQueryParser Scientific

parseInteger :: JordanQueryParser Integer

parseNull :: JordanQueryParser ()

parseBool :: JordanQueryParser Bool

validateJSON :: JordanQueryParser (Either Text a) -> JordanQueryParser a

nameParser :: Text -> JordanQueryParser a -> JordanQueryParser a

addFormat :: Text -> JordanQueryParser a -> JordanQueryParser a

Semigroup (JordanQueryParser a)

Defined in Jordan.Servant.Query.Parse

Methods

(<>) :: JordanQueryParser a -> JordanQueryParser a -> JordanQueryParser a

sconcat :: NonEmpty (JordanQueryParser a) -> JordanQueryParser a

stimes :: Integral b => b -> JordanQueryParser a -> JordanQueryParser a

newtype JordanQueryObjectParser a

Constructors

JordanQueryObjectParser

Fields

• runJordanQueryObjectParser :: Permutation QueryParser a

Instances

Functor JordanQueryObjectParser

Defined in Jordan.Servant.Query.Parse

Methods

fmap :: (a -> b) -> JordanQueryObjectParser a -> JordanQueryObjectParser b

(<$) :: a -> JordanQueryObjectParser b -> JordanQueryObjectParser a

Applicative JordanQueryObjectParser

Defined in Jordan.Servant.Query.Parse

Methods

pure :: a -> JordanQueryObjectParser a

(<*>) :: JordanQueryObjectParser (a -> b) -> JordanQueryObjectParser a -> JordanQueryObjectParser b

liftA2 :: (a -> b -> c) -> JordanQueryObjectParser a -> JordanQueryObjectParser b -> JordanQueryObjectParser c

(*>) :: JordanQueryObjectParser a -> JordanQueryObjectParser b -> JordanQueryObjectParser b

(<*) :: JordanQueryObjectParser a -> JordanQueryObjectParser b -> JordanQueryObjectParser a

JSONObjectParser JordanQueryObjectParser

Defined in Jordan.Servant.Query.Parse

Methods

parseFieldWith :: Text -> (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> JordanQueryObjectParser a

parseDescribeFieldWith :: Text -> Text -> (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> JordanQueryObjectParser a

parseField :: FromJSON v => Text -> JordanQueryObjectParser v

parseDescribeField :: FromJSON v => Text -> Text -> JordanQueryObjectParser v

parseFieldWithDefault :: Text -> (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> a -> JordanQueryObjectParser a

parseDescribeFieldWithDefault :: Text -> Text -> (forall (valueParser :: Type -> Type). JSONParser valueParser => valueParser a) -> a -> JordanQueryObjectParser a

addArrayBrackets :: QueryParser q -> QueryParser q

addJSONKey :: Text -> QueryParser q -> QueryParser q

toBool :: ByteString -> Either JSONError Bool

takeText :: QueryParser Text

parseQueryToKeys :: Query -> [(QueryKey, Maybe ByteString)]

filterToStarting :: Text -> [(QueryKey, Maybe ByteString)] -> [(QueryKey, Maybe ByteString)]

transformToKey :: Text -> Query -> [(QueryKey, Maybe ByteString)]

parseQueryAtKeyWith

Arguments

:: (forall jsonParser. JSONParser jsonParser => jsonParser a)

JSON parser to use. Note the rank-N type.

-> Text

Base key to use in the query string.

-> Query

Query string

-> Either String a

Either a value, or a brief (not super helpful) description of what went wrong.

Use Jordan to parse a query at a given "base" key.

We need a base key in case the JSON type is "just an int" or something.

hasQueryAtKey :: Text -> Query -> Bool

Determine if there are any query keys that match this base key.

>>> hasQueryAtKey "foo" (parseQuery "foo[bar][baz]=true")
True

>>> hasQueryAtKey "foo" (parseQuery "bar[baz]=true&bar[foo]=true&foo=true")
True

>>> hasQueryAtKey "foo" (parseQuery "bar[baz]=true&bar[foo]=true")
False

parseQueryAtKey :: FromJSON a => Text -> Query -> Either String a

Like parseQueryAtKeyWith, but uses the FromJSON instance, which is what you want 90% of the time.