Data.Apiary.Param

route path parameter

class Path a where

Minimal complete definition

readPath, pathRep

Methods

readPath :: Text -> Maybe a

read route path parameter.

pathRep :: proxy a -> TypeRep

Instances

Path Bool

javascript boolean. when "false", "0", "-0", "", "null", "undefined", "NaN" then False, else True. since 0.6.0.0.

Methods

readPath :: Text -> Maybe Bool

pathRep :: proxy Bool -> TypeRep

Path Char

Methods

readPath :: Text -> Maybe Char

pathRep :: proxy Char -> TypeRep

Path Double

Methods

readPath :: Text -> Maybe Double

pathRep :: proxy Double -> TypeRep

Path Float

Methods

readPath :: Text -> Maybe Float

pathRep :: proxy Float -> TypeRep

Path Int

Methods

readPath :: Text -> Maybe Int

pathRep :: proxy Int -> TypeRep

Path Int8

Methods

readPath :: Text -> Maybe Int8

pathRep :: proxy Int8 -> TypeRep

Path Int16

Methods

readPath :: Text -> Maybe Int16

pathRep :: proxy Int16 -> TypeRep

Path Int32

Methods

readPath :: Text -> Maybe Int32

pathRep :: proxy Int32 -> TypeRep

Path Int64

Methods

readPath :: Text -> Maybe Int64

pathRep :: proxy Int64 -> TypeRep

Path Integer

Methods

readPath :: Text -> Maybe Integer

pathRep :: proxy Integer -> TypeRep

Path Word

Methods

readPath :: Text -> Maybe Word

pathRep :: proxy Word -> TypeRep

Path Word8

Methods

readPath :: Text -> Maybe Word8

pathRep :: proxy Word8 -> TypeRep

Path Word16

Methods

readPath :: Text -> Maybe Word16

pathRep :: proxy Word16 -> TypeRep

Path Word32

Methods

readPath :: Text -> Maybe Word32

pathRep :: proxy Word32 -> TypeRep

Path Word64

Methods

readPath :: Text -> Maybe Word64

pathRep :: proxy Word64 -> TypeRep

Path ByteString

Methods

readPath :: Text -> Maybe ByteString

pathRep :: proxy ByteString -> TypeRep

Path ByteString

Methods

readPath :: Text -> Maybe ByteString

pathRep :: proxy ByteString -> TypeRep

Path String

Methods

readPath :: Text -> Maybe String

pathRep :: proxy String -> TypeRep

Path Text

Methods

readPath :: Text -> Maybe Text

pathRep :: proxy Text -> TypeRep

Path Text

Methods

readPath :: Text -> Maybe Text

pathRep :: proxy Text -> TypeRep

Path Day

fuzzy date parse. three decimal split by 1 char. if year < 100 then + 2000. since 0.16.0.

example:

• 2014-02-05
• 14-2-5
• 14.2.05

Methods

readPath :: Text -> Maybe Day

pathRep :: proxy Day -> TypeRep

readPathAs :: Path a => proxy a -> Text -> Maybe a

readPath providing type using Proxy.

query parameter

class Typeable a => Query a where

Minimal complete definition

readQuery

Methods

readQuery :: Maybe ByteString -> Maybe a

read query parameter.

queryRep :: proxy a -> QueryRep

pretty query parameter.

Instances

Query Bool

javascript boolean. when "false", "0", "-0", "", "null", "undefined", "NaN" then False, else True. since 0.6.0.0.

Methods

readQuery :: Maybe ByteString -> Maybe Bool

queryRep :: proxy Bool -> QueryRep

Query Double

Methods

readQuery :: Maybe ByteString -> Maybe Double

queryRep :: proxy Double -> QueryRep

Query Float

Methods

readQuery :: Maybe ByteString -> Maybe Float

queryRep :: proxy Float -> QueryRep

Query Int

Methods

readQuery :: Maybe ByteString -> Maybe Int

queryRep :: proxy Int -> QueryRep

Query Int8

Methods

readQuery :: Maybe ByteString -> Maybe Int8

queryRep :: proxy Int8 -> QueryRep

Query Int16

Methods

readQuery :: Maybe ByteString -> Maybe Int16

queryRep :: proxy Int16 -> QueryRep

Query Int32

Methods

readQuery :: Maybe ByteString -> Maybe Int32

queryRep :: proxy Int32 -> QueryRep

Query Int64

Methods

readQuery :: Maybe ByteString -> Maybe Int64

queryRep :: proxy Int64 -> QueryRep

Query Integer

Methods

readQuery :: Maybe ByteString -> Maybe Integer

queryRep :: proxy Integer -> QueryRep

Query Word

Methods

readQuery :: Maybe ByteString -> Maybe Word

queryRep :: proxy Word -> QueryRep

Query Word8

Methods

readQuery :: Maybe ByteString -> Maybe Word8

queryRep :: proxy Word8 -> QueryRep

Query Word16

Methods

readQuery :: Maybe ByteString -> Maybe Word16

queryRep :: proxy Word16 -> QueryRep

Query Word32

Methods

readQuery :: Maybe ByteString -> Maybe Word32

queryRep :: proxy Word32 -> QueryRep

Query Word64

Methods

readQuery :: Maybe ByteString -> Maybe Word64

queryRep :: proxy Word64 -> QueryRep

Query ()

always success. for check existence.

Methods

readQuery :: Maybe ByteString -> Maybe ()

queryRep :: proxy () -> QueryRep

Query ByteString

Methods

readQuery :: Maybe ByteString -> Maybe ByteString

queryRep :: proxy ByteString -> QueryRep

Query ByteString

Methods

readQuery :: Maybe ByteString -> Maybe ByteString

queryRep :: proxy ByteString -> QueryRep

Query String

Methods

readQuery :: Maybe ByteString -> Maybe String

queryRep :: proxy String -> QueryRep

Query Text

Methods

readQuery :: Maybe ByteString -> Maybe Text

queryRep :: proxy Text -> QueryRep

Query Text

Methods

readQuery :: Maybe ByteString -> Maybe Text

queryRep :: proxy Text -> QueryRep

Query Day

fuzzy date parse. three decimal split by 1 char. if year < 100 then + 2000. since 0.16.0.

example:

• 2014-02-05
• 14-2-5
• 14.2.05

Methods

readQuery :: Maybe ByteString -> Maybe Day

queryRep :: proxy Day -> QueryRep

Query a => Query (Maybe a)

allow no parameter. but check parameter type.

Methods

readQuery :: Maybe ByteString -> Maybe (Maybe a)

queryRep :: proxy (Maybe a) -> QueryRep

data QueryRep

Constructors

Strict TypeRep

require value

Nullable TypeRep

allow key only value

Check

check existance

NoValue

Instances

Eq QueryRep

Methods

(==) :: QueryRep -> QueryRep -> Bool

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

Show QueryRep

Methods

showsPrec :: Int -> QueryRep -> ShowS

show :: QueryRep -> String

showList :: [QueryRep] -> ShowS

data File

Constructors

File

Fields

• fileParameter :: ByteString
• fileName :: ByteString
• fileContentType :: ByteString
• fileContent :: Either ByteString FilePath

  check out uploadFilePath. since 2.0.0

  a Left value store file in memmory, a Right value contain FilePath of uploaded file.

Instances

Eq File

Methods

(==) :: File -> File -> Bool

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

Show File

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

ReqParam File

Methods

reqParams :: proxy File -> Query -> [Param] -> [File] -> [(ByteString, Maybe File)]

reqParamRep :: proxy File -> QueryRep

request parameter

type Param = (ByteString, ByteString)

class ReqParam a where

Minimal complete definition

reqParams, reqParamRep

Methods

reqParams :: proxy a -> Query -> [Param] -> [File] -> [(ByteString, Maybe a)]

reqParamRep :: proxy a -> QueryRep

Instances

Query a => ReqParam a

Methods

reqParams :: proxy a -> Query -> [Param] -> [File] -> [(ByteString, Maybe a)]

reqParamRep :: proxy a -> QueryRep

ReqParam File

Methods

reqParams :: proxy File -> Query -> [Param] -> [File] -> [(ByteString, Maybe File)]

reqParamRep :: proxy File -> QueryRep

Strategy

class Strategy w where

Minimal complete definition

strategy, strategyRep

Associated Types

type SNext w (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => w a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext w k a prms))

strategyRep :: w a -> StrategyRep

Instances

Strategy Optional

Associated Types

type SNext (Optional :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Optional a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Optional k a prms))

strategyRep :: Optional a -> StrategyRep

Strategy Option

Associated Types

type SNext (Option :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Option a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Option k a prms))

strategyRep :: Option a -> StrategyRep

Strategy Some

Associated Types

type SNext (Some :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Some a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Some k a prms))

strategyRep :: Some a -> StrategyRep

Strategy Many

Associated Types

type SNext (Many :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Many a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Many k a prms))

strategyRep :: Many a -> StrategyRep

Strategy One

Associated Types

type SNext (One :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => One a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext One k a prms))

strategyRep :: One a -> StrategyRep

Strategy First

Associated Types

type SNext (First :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => First a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext First k a prms))

strategyRep :: First a -> StrategyRep

newtype StrategyRep

Constructors

StrategyRep

Fields

• strategyInfo :: Text

Instances

Eq StrategyRep

Methods

(==) :: StrategyRep -> StrategyRep -> Bool

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

Show StrategyRep

Methods

showsPrec :: Int -> StrategyRep -> ShowS

show :: StrategyRep -> String

showList :: [StrategyRep] -> ShowS

data First a

Constructors

First

Instances

Strategy First

Associated Types

type SNext (First :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => First a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext First k a prms))

strategyRep :: First a -> StrategyRep

type SNext First k a ps

type SNext First k a ps = (:) (KV *) ((:=) * k a) ps

data One a

Constructors

One

Instances

Strategy One

Associated Types

type SNext (One :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => One a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext One k a prms))

strategyRep :: One a -> StrategyRep

type SNext One k a ps

type SNext One k a ps = (:) (KV *) ((:=) * k a) ps

data Many a

Constructors

Many

Instances

Strategy Many

Associated Types

type SNext (Many :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Many a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Many k a prms))

strategyRep :: Many a -> StrategyRep

type SNext Many k a ps

type SNext Many k a ps = (:) (KV *) ((:=) * k [a]) ps

data Some a

Constructors

Some

Instances

Strategy Some

Associated Types

type SNext (Some :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Some a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Some k a prms))

strategyRep :: Some a -> StrategyRep

type SNext Some k a ps

type SNext Some k a ps = (:) (KV *) ((:=) * k [a]) ps

data Option a

Constructors

Option

Instances

Strategy Option

Associated Types

type SNext (Option :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Option a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Option k a prms))

strategyRep :: Option a -> StrategyRep

type SNext Option k a ps

type SNext Option k a ps = (:) (KV *) ((:=) * k (Maybe a)) ps

data Optional a

Constructors

Optional Text a

Instances

Strategy Optional

Associated Types

type SNext (Optional :: * -> *) (k :: Symbol) a (prms :: [KV *]) :: [KV *]

Methods

strategy :: (KnownSymbol k, k </ prms, MonadPlus m) => Optional a -> proxy' k -> [Maybe a] -> Store prms -> m (Store (SNext Optional k a prms))

strategyRep :: Optional a -> StrategyRep

type SNext Optional k a ps

type SNext Optional k a ps = (:) (KV *) ((:=) * k a) ps

Proxies

pBool :: Proxy Bool

pInt :: Proxy Int

pWord :: Proxy Word

pDouble :: Proxy Double

pText :: Proxy Text

pLazyText :: Proxy Text

pByteString :: Proxy ByteString

pLazyByteString :: Proxy ByteString

pString :: Proxy String

pMaybe :: proxy a -> Proxy (Maybe a)

pFile :: Proxy File

strategy

pFirst :: proxy a -> First a

pOne :: proxy a -> One a

pMany :: proxy a -> Many a

pSome :: proxy a -> Some a

pOption :: proxy a -> Option a

pOptional :: Show a => a -> Optional a