strelka-2.0.5: A simple, flexible and composable web-router

Safe Haskell	None
Language	Haskell2010

Strelka.ParamsParsing

Contents

Multi-arity default param parser helpers
Value parsers
Implicit default value parsers

Description

DSL for parsing of parameters.

Synopsis

data Params a
param :: Text -> Value a -> Params a
defaultParam :: DefaultValue a => Text -> Params a
defaultParams1 :: DefaultValue a => Text -> Params a
defaultParams2 :: (DefaultValue a, DefaultValue b) => Text -> Text -> Params (a, b)
defaultParams3 :: (DefaultValue a, DefaultValue b, DefaultValue c) => Text -> Text -> Text -> Params (a, b, c)
defaultParams4 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d) => Text -> Text -> Text -> Text -> Params (a, b, c, d)
defaultParams5 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d, DefaultValue e) => Text -> Text -> Text -> Text -> Text -> Params (a, b, c, d, e)
defaultParams6 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d, DefaultValue e, DefaultValue f) => Text -> Text -> Text -> Text -> Text -> Text -> Params (a, b, c, d, e, f)
defaultParams7 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d, DefaultValue e, DefaultValue f, DefaultValue g) => Text -> Text -> Text -> Text -> Text -> Text -> Text -> Params (a, b, c, d, e, f, g)
data Value a
parser :: Parser a -> Value a
matcher :: (Text -> Either Text a) -> Value a
list :: Value a -> Value [a]
maybe :: Value a -> Value (Maybe a)
class DefaultValue value where
- defaultValue :: Value value

Documentation

data Params a Source #

Parser of a product of parameters.

Can be composed using the Applicative interface.

Instances

Functor Params Source #
Instance details Defined in Strelka.ParamsParsing.Params Methods fmap :: (a -> b) -> Params a -> Params b # (<$) :: a -> Params b -> Params a #
Applicative Params Source #
Instance details Defined in Strelka.ParamsParsing.Params Methods pure :: a -> Params a # (<>) :: Params (a -> b) -> Params a -> Params b # liftA2 :: (a -> b -> c) -> Params a -> Params b -> Params c # (>) :: Params a -> Params b -> Params b # (<*) :: Params a -> Params b -> Params a #
Alternative Params Source #
Instance details Defined in Strelka.ParamsParsing.Params Methods empty :: Params a # (<\|>) :: Params a -> Params a -> Params a # some :: Params a -> Params [a] # many :: Params a -> Params [a] #

param :: Text -> Value a -> Params a Source #

Parse a param by its name using an explicit parser.

defaultParam :: DefaultValue a => Text -> Params a Source #

Parse a param by its name using the implicit default parser.

Multi-arity default param parser helpers

defaultParams1 :: DefaultValue a => Text -> Params a Source #

Same as defaultParam.

defaultParams2 :: (DefaultValue a, DefaultValue b) => Text -> Text -> Params (a, b) Source #

A helper abstracting over the Applicative composition of multiple defaultParam.

defaultParams3 :: (DefaultValue a, DefaultValue b, DefaultValue c) => Text -> Text -> Text -> Params (a, b, c) Source #

A helper abstracting over the Applicative composition of multiple defaultParam.

defaultParams4 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d) => Text -> Text -> Text -> Text -> Params (a, b, c, d) Source #

A helper abstracting over the Applicative composition of multiple defaultParam.

defaultParams5 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d, DefaultValue e) => Text -> Text -> Text -> Text -> Text -> Params (a, b, c, d, e) Source #

A helper abstracting over the Applicative composition of multiple defaultParam.

defaultParams6 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d, DefaultValue e, DefaultValue f) => Text -> Text -> Text -> Text -> Text -> Text -> Params (a, b, c, d, e, f) Source #

A helper abstracting over the Applicative composition of multiple defaultParam.

defaultParams7 :: (DefaultValue a, DefaultValue b, DefaultValue c, DefaultValue d, DefaultValue e, DefaultValue f, DefaultValue g) => Text -> Text -> Text -> Text -> Text -> Text -> Text -> Params (a, b, c, d, e, f, g) Source #

A helper abstracting over the Applicative composition of multiple defaultParam.

Value parsers

data Value a Source #

A parser of a parameter value.

Instances

Functor Value Source #
Instance details Defined in Strelka.ParamsParsing.Value Methods fmap :: (a -> b) -> Value a -> Value b # (<$) :: a -> Value b -> Value a #
Applicative Value Source #
Instance details Defined in Strelka.ParamsParsing.Value Methods pure :: a -> Value a # (<>) :: Value (a -> b) -> Value a -> Value b # liftA2 :: (a -> b -> c) -> Value a -> Value b -> Value c # (>) :: Value a -> Value b -> Value b # (<*) :: Value a -> Value b -> Value a #
Alternative Value Source #
Instance details Defined in Strelka.ParamsParsing.Value Methods empty :: Value a # (<\|>) :: Value a -> Value a -> Value a # some :: Value a -> Value [a] # many :: Value a -> Value [a] #

parser :: Parser a -> Value a Source #

Lifts an Attoparsec parser into Value.

matcher :: (Text -> Either Text a) -> Value a Source #

Lifts a text-matching function into Value.

list :: Value a -> Value [a] Source #

Lifts a single value parser to the parser of a list of values.

Useful for decoding lists of values of the same name. E.g., it'll work for the both following cases:

?param[]=1&param[]=2

?param=1&param=2

In both cases the name of the parameter to look up will be "param".

maybe :: Value a -> Value (Maybe a) Source #

Lifts a single value parser to the parser of a possibly specified value.

It's useful for decoding the difference between the following two cases:

?param=value

?param

Implicit default value parsers

class DefaultValue value where Source #

Provides a default value parser.

Methods

defaultValue :: Value value Source #

Instances

DefaultValue Bool Source #	Interprets all the following inputs case-insensitively: "1" or "0", "true" or "false", "yes" or "no", "y" or "n", "t" or "f". The absense of a value is interpreted as `False`.
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Bool Source #
DefaultValue Char Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Char Source #
DefaultValue Double Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Double Source #
DefaultValue Int Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Int Source #
DefaultValue Int8 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Int8 Source #
DefaultValue Int16 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Int16 Source #
DefaultValue Int32 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Int32 Source #
DefaultValue Int64 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Int64 Source #
DefaultValue Integer Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Integer Source #
DefaultValue Word Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Word Source #
DefaultValue Word8 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Word8 Source #
DefaultValue Word16 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Word16 Source #
DefaultValue Word32 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Word32 Source #
DefaultValue Word64 Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Word64 Source #
DefaultValue ByteString Source #	Encodes the input using UTF8.
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value ByteString Source #
DefaultValue Text Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Text Source #
DefaultValue String Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value String Source #
DefaultValue UUID Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value UUID Source #
DefaultValue Scientific Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Scientific Source #
DefaultValue TimeOfDay Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value TimeOfDay Source #
DefaultValue TimeZone Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value TimeZone Source #
DefaultValue UTCTime Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value UTCTime Source #
DefaultValue Day Source #
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value Day Source #
DefaultValue a => DefaultValue [a] Source #	Uses `list` over `defaultValue`.
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value [a] Source #
DefaultValue a => DefaultValue (Maybe a) Source #	Uses `maybe` over `defaultValue`.
Instance details Defined in Strelka.ParamsParsing.DefaultValue Methods defaultValue :: Value (Maybe a) Source #