Safe Haskell	None

Control.Monad.Apiary.Filter

Contents

filters
Reexport

Synopsis

filters

http method

method :: (Functor n, Monad n) => Method -> ApiaryT c n m a -> ApiaryT c n m aSource

filter by HTTP method. since 0.1.0.0.

stdMethod :: (Functor n, Monad n) => StdMethod -> ApiaryT c n m a -> ApiaryT c n m aSource

filter by HTTP method using StdMethod. since 0.1.0.0.

http version

httpVersion :: (Functor n, Monad n) => HttpVersion -> ApiaryT c n m b -> ApiaryT c n m bSource

http version filter. since 0.5.0.0.

http09 :: (Functor n, Monad n) => ApiaryT c n m b -> ApiaryT c n m bSource

http/0.9 only accepted fiter. since 0.5.0.0.

http10 :: (Functor n, Monad n) => ApiaryT c n m b -> ApiaryT c n m bSource

http/1.0 only accepted fiter. since 0.5.0.0.

http11 :: (Functor n, Monad n) => ApiaryT c n m b -> ApiaryT c n m bSource

http/1.1 only accepted fiter. since 0.5.0.0.

path matcher

root :: (Functor n, Monad n) => ApiaryT c n m b -> ApiaryT c n m bSource

filter by rootPattern of ApiaryConfig.

capture :: QuasiQuoter Source

capture QuasiQuoter. since 0.1.0.0.

example:

 [capture|/path|] -- first path == path
 [capture|/int/:Int|] -- first path == int && get 2nd path as Int.
 [capture|/:Int/:Double|] -- get first path as Int and get 2nd path as Double.

path :: (Functor n, Monad n) => Text -> ApiaryT c n m a -> ApiaryT c n m aSource

check first path and drill down. since v0.11.0.

fetch :: (Path a, Functor n, Monad n) => proxy a -> ApiaryT (Snoc as a) n m b -> ApiaryT as n m bSource

get first path and drill down. since v0.11.0.

query matcher

query :: forall a as w n m b. (ReqParam a, Strategy w, Functor n, MonadIO n) => ByteString -> Proxy (w a) -> ApiaryT (SNext w as a) n m b -> ApiaryT as n m bSource

low level query getter. since 0.5.0.0.

 query key (Proxy :: Proxy (fetcher type))

examples:

 query key (Proxy :: Proxy (First Int)) -- get first 'key' query parameter as Int.
 query key (Proxy :: Proxy (Option (Maybe Int)) -- get first 'key' query parameter as Int. allow without param or value.
 query key (Proxy :: Proxy (Many String) -- get all 'key' query parameter as String.

specified operators

(=:) :: (Functor n, MonadIO n, ReqParam a) => ByteString -> Proxy a -> ApiaryT (Snoc as a) n m b -> ApiaryT as n m bSource

get first matched paramerer. since 0.5.0.0.

 key =: pInt == query key (pFirst pInt) == query key (Proxy :: Proxy (First Int))

(=!:) :: (Functor n, MonadIO n, ReqParam a) => ByteString -> Proxy a -> ApiaryT (Snoc as a) n m b -> ApiaryT as n m bSource

get one matched paramerer. since 0.5.0.0.

when more one parameger given, not matched.

 key =: pInt == query key (pOne pInt) == query key (Proxy :: Proxy (One Int))

(=?:) :: (Functor n, MonadIO n, ReqParam a) => ByteString -> Proxy a -> ApiaryT (Snoc as (Maybe a)) n m b -> ApiaryT as n m bSource

get optional first paramerer. since 0.5.0.0.

when illegal type parameter given, fail mather(don't give Nothing).

 key =: pInt == query key (pOption pInt) == query key (Proxy :: Proxy (Option Int))

(?:) :: (Functor n, MonadIO n, ReqParam a) => ByteString -> Proxy a -> ApiaryT as n m b -> ApiaryT as n m bSource

check parameger given and type. since 0.5.0.0.

If you wan't to allow any type, give pVoid.

 key =: pInt == query key (pCheck pInt) == query key (Proxy :: Proxy (Check Int))

(=*:) :: (Functor n, MonadIO n, ReqParam a) => ByteString -> Proxy a -> ApiaryT (Snoc as [a]) n m b -> ApiaryT as n m bSource

get many paramerer. since 0.5.0.0.

 key =: pInt == query key (pMany pInt) == query key (Proxy :: Proxy (Many Int))

(=+:) :: (Functor n, MonadIO n, ReqParam a) => ByteString -> Proxy a -> ApiaryT (Snoc as [a]) n m b -> ApiaryT as n m bSource

get some paramerer. since 0.5.0.0.

 key =: pInt == query key (pSome pInt) == query key (Proxy :: Proxy (Some Int))

hasQuery :: (Functor n, MonadIO n) => ByteString -> ApiaryT c n m a -> ApiaryT c n m aSource

query exists checker.

 hasQuery q = query q (Proxy :: Proxy (Check ()))

header matcher

hasHeader :: (Functor n, Monad n) => HeaderName -> ApiaryT as n m b -> ApiaryT as n m bSource

check whether to exists specified header or not. since 0.6.0.0.

eqHeader Source

Arguments

:: (Functor n, Monad n)
=> HeaderName
-> ByteString	header value
-> ApiaryT as n m b
-> ApiaryT as n m b

check whether to exists specified valued header or not. since 0.6.0.0.

headers :: (Functor n, Monad n) => HeaderName -> ApiaryT (Snoc as [ByteString]) n m b -> ApiaryT as n m bSource

filter by headers up to 100 entries. since 0.6.0.0.

header :: (Functor n, Monad n) => HeaderName -> ApiaryT (Snoc as ByteString) n m b -> ApiaryT as n m bSource

filter by header and get first. since 0.6.0.0.

header' :: (Strategy w, Functor n, Monad n) => (forall x. Proxy x -> Proxy (w x)) -> (Header -> Bool) -> ApiaryT (SNext w as ByteString) n m b -> ApiaryT as n m bSource

low level header filter. since 0.6.0.0.

other

ssl :: (Functor n, Monad n) => ApiaryT c n m a -> ApiaryT c n m aSource

filter by ssl accessed. since 0.1.0.0.

Reexport

StdMethod(..)

module Network.HTTP.Types

Strategy Proxies

module Control.Monad.Apiary.Filter.Internal.Strategy