Control.Monad.Apiary.Filter

Contents

• http method
• http version
• path matcher
• query matcher
• header matcher
• other
• not export from Web.Apiary

Synopsis

• method :: Monad actM => Method -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• http09 :: Monad actM => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• http10 :: Monad actM => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• http11 :: Monad actM => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• root :: (Monad m, Monad actM) => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• capture :: QuasiQuoter
• (??) :: proxy key -> Html -> QueryKey key
• (=:) :: (HasDesc query, MonadIO actM, ReqParam v, KnownSymbol k, NotMember k prms) => query k -> proxy v -> ApiaryT exts ((k := v) : prms) actM m () -> ApiaryT exts prms actM m ()
• (=!:) :: (HasDesc query, MonadIO actM, ReqParam v, KnownSymbol k, NotMember k prms) => query k -> proxy v -> ApiaryT exts ((k := v) : prms) actM m () -> ApiaryT exts prms actM m ()
• (=?:) :: (HasDesc query, MonadIO actM, ReqParam v, KnownSymbol k, NotMember k prms) => query k -> proxy v -> ApiaryT exts ((k := Maybe v) : prms) actM m () -> ApiaryT exts prms actM m ()
• (=?!:) :: forall query k v exts prms actM m. (HasDesc query, MonadIO actM, Show v, ReqParam v, KnownSymbol k, NotMember k prms) => query k -> v -> ApiaryT exts ((k := v) : prms) actM m () -> ApiaryT exts prms actM m ()
• (=*:) :: (HasDesc query, MonadIO actM, ReqParam v, KnownSymbol k, NotMember k prms) => query k -> proxy v -> ApiaryT exts ((k := [v]) : prms) actM m () -> ApiaryT exts prms actM m ()
• (=+:) :: (HasDesc query, MonadIO actM, ReqParam v, KnownSymbol k, NotMember k prms) => query k -> proxy v -> ApiaryT exts ((k := [v]) : prms) actM m () -> ApiaryT exts prms actM m ()
• switchQuery :: (HasDesc proxy, MonadIO actM, KnownSymbol k, NotMember k prms) => proxy k -> ApiaryT exts ((k := Bool) : prms) actM m () -> ApiaryT exts prms actM m ()
• eqHeader :: (KnownSymbol k, Monad actM) => proxy k -> ByteString -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• header :: (KnownSymbol k, Monad actM, NotMember k prms) => proxy k -> ApiaryT exts ((k := ByteString) : prms) actM m () -> ApiaryT exts prms actM m ()
• accept :: Monad actM => ContentType -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• ssl :: Monad actM => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• class HasDesc a where
  • queryDesc :: a key -> Maybe Html
• newtype QueryKey key = QueryKey {
  • queryKeyDesc :: Maybe Html
  }
• query :: forall query strategy k v exts prms actM m. (NotMember k prms, MonadIO actM, KnownSymbol k, ReqParam v, HasDesc query, Strategy strategy) => query k -> strategy v -> ApiaryT exts (SNext strategy k v prms) actM m () -> ApiaryT exts prms actM m ()
• httpVersion :: Monad actM => HttpVersion -> Html -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• path :: Monad actM => Text -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• endPath :: Monad actM => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• fetch :: forall proxy k p exts prms actM m. (NotMember k prms, KnownSymbol k, Path p, Monad actM) => proxy (k := p) -> Maybe Html -> ApiaryT exts ((k := p) : prms) actM m () -> ApiaryT exts prms actM m ()
• restPath :: (NotMember k prms, KnownSymbol k, Monad m, Monad actM) => proxy k -> Maybe Html -> ApiaryT exts ((k := [Text]) : prms) actM m () -> ApiaryT exts prms actM m ()
• anyPath :: (Monad m, Monad actM) => ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• function :: Monad actM => (Doc -> Doc) -> (Dict prms -> Request -> Maybe (Dict prms')) -> ApiaryT exts prms' actM m () -> ApiaryT exts prms actM m ()
• function' :: (KnownSymbol key, Monad actM, NotMember key prms) => (Doc -> Doc) -> (Request -> Maybe (proxy key, prm)) -> ApiaryT exts ((key := prm) : prms) actM m () -> ApiaryT exts prms actM m ()
• function_ :: Monad actM => (Doc -> Doc) -> (Request -> Bool) -> ApiaryT exts prms actM m () -> ApiaryT exts prms actM m ()
• focus :: Monad actM => (Doc -> Doc) -> ActionT exts prms actM (Dict prms') -> ApiaryT exts prms' actM m () -> ApiaryT exts prms actM m ()
• data Doc
  • = DocRoot Doc
  • | DocMethod Method Doc
  • | DocQuery Text StrategyRep QueryRep (Maybe Html) Doc
  • | DocPrecondition Html Doc
  • | DocAccept ByteString Doc

http method

method GET      -- stdmethod
method "HOGE" -- non standard method

http version

path matcher

[capture|/path|] -- first path == "path"
[capture|/int/foo::Int|] -- first path == "int" && get 2nd path as Int.
[capture|/bar::Int/baz::Double|] -- get first path as Int and get 2nd path as Double.
[capture|/**baz|] -- feed greedy and get all path as [Text] (since 0.17.0). 

[capture|foofoo::Int|]        == path "path" . fetch (Proxy :: Proxy ("foo" := Int)) . endPath
[capture|barbar::Int/**rest|] == path "path" . fetch (Proxy :: Proxy ("foo" := Int)) . restPath (Proxy :: Proxy "rest")

query matcher

[key|key|] ?? "document" =: pInt

[key|key|] =: pInt

[key|key|] =!: pInt

[key|key|] =?: pInt

[key|key|] =!?: (0 :: Int)

[key|key|] =*: pInt

[key|key|] =+: pInt

header matcher

other

not export from Web.Apiary