Copyright	(c) 2015 2016 2017 2018 Athan Clark
License	BSD-style
Maintainer	[email protected]
Stability	experimental
Portability	GHC
Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Routes.Nested.Types

Contents

Internal Structure
Builder
Book Keeping

Description

Synopsis

data Tries x s = Tries {
- trieContent :: !(RootedPredTrie Text x)
- trieCatchAll :: !(RootedPredTrie Text x)
- trieSecurity :: !(RootedPredTrie Text s)
}
newtype RouterT x sec m a = RouterT {
- runRouterT :: StateT (Tries x sec) m a
}
execRouterT :: Monad m => RouterT x sec m a -> m (Tries x sec)
type ActionT urlbase m a = VerbListenerT (FileExtListenerT urlbase m a) m a
action :: MonadBaseControl IO m stM => Extractable stM => ActionT urlbase m () -> MiddlewareT m
type ExtrudeSoundly xs' xs c r = (xs' ~ CatMaybes xs, ArityTypeListIso c xs' r, Extrude (UrlChunks xs) (RootedPredTrie Text c) (RootedPredTrie Text r))

Internal Structure

data Tries x s Source #

The internal data structure built during route declaration.

Constructors

Tries
Fields trieContent :: !(RootedPredTrie Text x) trieCatchAll :: !(RootedPredTrie Text x) trieSecurity :: !(RootedPredTrie Text s)

Instances

Instances details

Monoid (Tries x s) Source #
Instance details Defined in Web.Routes.Nested.Types Methods mempty :: Tries x s # mappend :: Tries x s -> Tries x s -> Tries x s # mconcat :: [Tries x s] -> Tries x s #
Semigroup (Tries x s) Source #
Instance details Defined in Web.Routes.Nested.Types Methods (<>) :: Tries x s -> Tries x s -> Tries x s # sconcat :: NonEmpty (Tries x s) -> Tries x s # stimes :: Integral b => b -> Tries x s -> Tries x s #
Monad m => MonadState (Tries x sec) (RouterT x sec m) Source #
Instance details Defined in Web.Routes.Nested.Types Methods get :: RouterT x sec m (Tries x sec) # put :: Tries x sec -> RouterT x sec m () # state :: (Tries x sec -> (a, Tries x sec)) -> RouterT x sec m a #

Builder

newtype RouterT x sec m a Source #

The (syntactic) monad for building a router with functions like "Web.Routes.Nested.match". it should have a shape of RouterT (MiddlewareT m) (SecurityToken s) m a when used with "Web.Routes.Nested.route".

Constructors

RouterT
Fields runRouterT :: StateT (Tries x sec) m a

Instances

Instances details

MonadTrans (RouterT x sec) Source #
Instance details Defined in Web.Routes.Nested.Types Methods lift :: Monad m => m a -> RouterT x sec m a #
Monad m => MonadState (Tries x sec) (RouterT x sec m) Source #
Instance details Defined in Web.Routes.Nested.Types Methods get :: RouterT x sec m (Tries x sec) # put :: Tries x sec -> RouterT x sec m () # state :: (Tries x sec -> (a, Tries x sec)) -> RouterT x sec m a #
MonadIO m => MonadIO (RouterT x sec m) Source #
Instance details Defined in Web.Routes.Nested.Types Methods liftIO :: IO a -> RouterT x sec m a #
Monad m => Applicative (RouterT x sec m) Source #
Instance details Defined in Web.Routes.Nested.Types Methods pure :: a -> RouterT x sec m a # (<>) :: RouterT x sec m (a -> b) -> RouterT x sec m a -> RouterT x sec m b # liftA2 :: (a -> b -> c) -> RouterT x sec m a -> RouterT x sec m b -> RouterT x sec m c # (>) :: RouterT x sec m a -> RouterT x sec m b -> RouterT x sec m b # (<*) :: RouterT x sec m a -> RouterT x sec m b -> RouterT x sec m a #
Functor m => Functor (RouterT x sec m) Source #
Instance details Defined in Web.Routes.Nested.Types Methods fmap :: (a -> b) -> RouterT x sec m a -> RouterT x sec m b # (<$) :: a -> RouterT x sec m b -> RouterT x sec m a #
Monad m => Monad (RouterT x sec m) Source #
Instance details Defined in Web.Routes.Nested.Types Methods (>>=) :: RouterT x sec m a -> (a -> RouterT x sec m b) -> RouterT x sec m b # (>>) :: RouterT x sec m a -> RouterT x sec m b -> RouterT x sec m b # return :: a -> RouterT x sec m a #

execRouterT :: Monad m => RouterT x sec m a -> m (Tries x sec) Source #

Run the monad, only getting the built state and throwing away a.

type ActionT urlbase m a = VerbListenerT (FileExtListenerT urlbase m a) m a Source #

The type of "content" builders; using the wai-middleware-verbs and wai-middleware-content-type packages.

action :: MonadBaseControl IO m stM => Extractable stM => ActionT urlbase m () -> MiddlewareT m Source #

Run the content builder into a middleware that responds when the content is satisfiable (i.e. Accept headers are O.K., etc.)

Book Keeping

type ExtrudeSoundly xs' xs c r = (xs' ~ CatMaybes xs, ArityTypeListIso c xs' r, Extrude (UrlChunks xs) (RootedPredTrie Text c) (RootedPredTrie Text r)) Source #

Soundness constraint showing that a function's arity can be represented as a type-level list.