Strelka.ParamsParsing

DSL for parsing of parameters.

Documentation

data Params a

Parser of a product of parameters.

Can be composed using the Applicative interface.

Instances

Functor Params

Methods

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

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

Applicative Params

Methods

pure :: a -> Params a

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

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

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

Alternative 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

Parse a param by its name using an explicit parser.

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

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

Multi-arity default param parser helpers

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

Same as defaultParam.

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

A helper abstracting over the Applicative composition of multiple defaultParam.

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

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)

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)

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)

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)

A helper abstracting over the Applicative composition of multiple defaultParam.

Value parsers

data Value a

A parser of a parameter value.

Instances

Functor Value

Methods

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

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

Applicative Value

Methods

pure :: a -> Value a

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

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

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

Alternative 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

Lifts an Attoparsec parser into Value.

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

Lifts a text-matching function into Value.

list :: Value a -> Value [a]

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)

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

Provides a default value parser.

Minimal complete definition

defaultValue

Methods

defaultValue :: Value value

Instances

DefaultValue Bool

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.

Methods

defaultValue :: Value Bool

DefaultValue Char

Methods

defaultValue :: Value Char

DefaultValue Double

Methods

defaultValue :: Value Double

DefaultValue Int

Methods

defaultValue :: Value Int

DefaultValue Int8

Methods

defaultValue :: Value Int8

DefaultValue Int16

Methods

defaultValue :: Value Int16

DefaultValue Int32

Methods

defaultValue :: Value Int32

DefaultValue Int64

Methods

defaultValue :: Value Int64

DefaultValue Integer

Methods

defaultValue :: Value Integer

DefaultValue Word

Methods

defaultValue :: Value Word

DefaultValue Word8

Methods

defaultValue :: Value Word8

DefaultValue Word16

Methods

defaultValue :: Value Word16

DefaultValue Word32

Methods

defaultValue :: Value Word32

DefaultValue Word64

Methods

defaultValue :: Value Word64

DefaultValue ByteString

Encodes the input using UTF8.

Methods

defaultValue :: Value ByteString

DefaultValue Text

Methods

defaultValue :: Value Text

DefaultValue String

Methods

defaultValue :: Value String

DefaultValue Scientific

Methods

defaultValue :: Value Scientific

DefaultValue TimeOfDay

Methods

defaultValue :: Value TimeOfDay

DefaultValue TimeZone

Methods

defaultValue :: Value TimeZone

DefaultValue UTCTime

Methods

defaultValue :: Value UTCTime

DefaultValue Day

Methods

defaultValue :: Value Day

DefaultValue a => DefaultValue [a]

Uses list over defaultValue.

Methods

defaultValue :: Value [a]

DefaultValue a => DefaultValue (Maybe a)

Uses maybe over defaultValue.

Methods

defaultValue :: Value (Maybe a)