Safe Haskell	None
Language	GHC2024

Okapi.HTTP.Request.Query

Synopsis

data Query a where
- Raw :: Query [QueryItem]
- Param :: forall a. Text -> Leaf Query a -> Query a
- Param' :: forall a1. Text -> Leaf Query a1 -> Query (Maybe a1)
- Param_ :: forall a1. Text -> Leaf Query a1 -> a1 -> Query ()
- Flag :: Text -> Query ()
- Flag' :: Text -> Query Bool
- List :: forall a1. ArrayStyle -> Text -> Leaf Query a1 -> Query (NonEmpty a1)
- List' :: forall a1. ArrayStyle -> Text -> Leaf Query a1 -> Query [a1]
data ArrayStyle
- = Exploded
- | CommaDelimited
- | SpaceDelimited
- | PipeDelimited
data ParseError = ParseError
parser :: Tree Query i o -> Parser Query o
printer :: Tree Query i o -> Printer Query i
raw :: Tree Query Query Query
param :: Text -> Leaf Query a -> Tree Query a a
param' :: Text -> Leaf Query a -> Tree Query (Maybe a) (Maybe a)
param_ :: Text -> Leaf Query a -> a -> Tree Query () ()
flag :: Text -> Tree Query () ()
flag' :: Text -> Tree Query Bool Bool
list :: ArrayStyle -> Text -> Leaf Query a -> Tree Query (NonEmpty a) (NonEmpty a)
list' :: ArrayStyle -> Text -> Leaf Query a -> Tree Query [a] [a]
class GQuery (f :: Type -> Type) where
- gQueryCodec :: Tree Query (f ()) (f ())
queryCodec :: (Generic a, GQuery (Rep a)) => Tree Query a a

Documentation

data Query a where Source #

Constructors

Raw :: Query [QueryItem]
Param :: forall a. Text -> Leaf Query a -> Query a
Param' :: forall a1. Text -> Leaf Query a1 -> Query (Maybe a1)
Param_ :: forall a1. Text -> Leaf Query a1 -> a1 -> Query ()
Flag :: Text -> Query ()
Flag' :: Text -> Query Bool
List :: forall a1. ArrayStyle -> Text -> Leaf Query a1 -> Query (NonEmpty a1)
List' :: forall a1. ArrayStyle -> Text -> Leaf Query a1 -> Query [a1]

Instances

Instances details

HasLeaf Query Int16 Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Int16 Source #
HasLeaf Query Int32 Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Int32 Source #
HasLeaf Query Int64 Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Int64 Source #
HasLeaf Query Text Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Text Source #
HasLeaf Query Day Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Day Source #
HasLeaf Query UTCTime Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query UTCTime Source #
HasLeaf Query UUID Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query UUID Source #
HasLeaf Query Integer Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Integer Source #
HasLeaf Query Bool Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Bool Source #
HasLeaf Query Double Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Double Source #
HasLeaf Query Float Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Float Source #
HasLeaf Query Int Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods leaf :: Leaf Query Int Source #
type Context Query Source #
Instance details Defined in Okapi.HTTP.Request.Query type Context Query = Query
type Failure Query Source #
Instance details Defined in Okapi.HTTP.Request.Query type Failure Query = ParseError
type Piece Query Source #
Instance details Defined in Okapi.HTTP.Request.Query type Piece Query = Text

data ArrayStyle Source #

Constructors

Exploded
CommaDelimited
SpaceDelimited
PipeDelimited

Instances

Instances details

Show ArrayStyle Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods showsPrec :: Int -> ArrayStyle -> ShowS # show :: ArrayStyle -> String # showList :: [ArrayStyle] -> ShowS #
Eq ArrayStyle Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods (==) :: ArrayStyle -> ArrayStyle -> Bool # (/=) :: ArrayStyle -> ArrayStyle -> Bool #

data ParseError Source #

Constructors

ParseError

Instances

Instances details

Show ParseError Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS #
Eq ParseError Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods (==) :: ParseError -> ParseError -> Bool # (/=) :: ParseError -> ParseError -> Bool #

parser :: Tree Query i o -> Parser Query o Source #

printer :: Tree Query i o -> Printer Query i Source #

raw :: Tree Query Query Query Source #

param :: Text -> Leaf Query a -> Tree Query a a Source #

Parse and print a required query parameter.

printParse parser printer (param "k" int) (x :: Int)

printStable parser printer (param "k" int) (x :: Int)

param' :: Text -> Leaf Query a -> Tree Query (Maybe a) (Maybe a) Source #

Parse and print an optional query parameter.

printParse parser printer (param' "k" int) (x :: Maybe Int)

printStable parser printer (param' "k" int) (x :: Maybe Int)

param_ :: Text -> Leaf Query a -> a -> Tree Query () () Source #

flag :: Text -> Tree Query () () Source #

Parse and print a boolean flag (presence = True).

printParse parser printer (flag "f") ()

printParse parser printer (flag' "f") (x :: Bool)

printStable parser printer (flag' "f") (x :: Bool)

flag' :: Text -> Tree Query Bool Bool Source #

list :: ArrayStyle -> Text -> Leaf Query a -> Tree Query (NonEmpty a) (NonEmpty a) Source #

Parse and print a non-empty list of query parameters.

printParse parser printer (list Exploded "k" int) (x :| xs)

printParse parser printer (list CommaDelimited "k" int) (x :| xs)

printStable parser printer (list Exploded "k" int) (x :| xs)

list' :: ArrayStyle -> Text -> Leaf Query a -> Tree Query [a] [a] Source #

class GQuery (f :: Type -> Type) where Source #

Methods

gQueryCodec :: Tree Query (f ()) (f ()) Source #

Instances

Instances details

(GQuery f, GQuery g) => GQuery (f :*: g) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query ((f :: g) ()) ((f :: g) ()) Source #
GQuery f => GQuery (C1 meta f) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query (C1 meta f ()) (C1 meta f ()) Source #
GQuery f => GQuery (D1 meta f) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query (D1 meta f ()) (D1 meta f ()) Source #
(Selector s, HasLeaf Query a) => GQuery (S1 s (Rec0 (Maybe a))) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query (S1 s (Rec0 (Maybe a)) ()) (S1 s (Rec0 (Maybe a)) ()) Source #
Selector s => GQuery (S1 s (Rec0 ())) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query (S1 s (Rec0 ()) ()) (S1 s (Rec0 ()) ()) Source #
Selector s => GQuery (S1 s (Rec0 Bool)) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query (S1 s (Rec0 Bool) ()) (S1 s (Rec0 Bool) ()) Source #
(Selector s, HasLeaf Query a) => GQuery (S1 s (Rec0 a)) Source #
Instance details Defined in Okapi.HTTP.Request.Query Methods gQueryCodec :: Tree Query (S1 s (Rec0 a) ()) (S1 s (Rec0 a) ()) Source #

queryCodec :: (Generic a, GQuery (Rep a)) => Tree Query a a Source #