Web.Routing.AbstractRouter

Documentation

class AbstractRouter r where

Associated Types

data Registry r :: *

data RoutePath r :: [*] -> *

type RouteAction r :: [*] -> *

type RouteAppliedAction r

Methods

subcompCombine :: RoutePath r [] -> RoutePath r as -> RoutePath r as

emptyRegistry :: Registry r

rootPath :: RoutePath r []

defRoute :: RoutePath r as -> RouteAction r as -> Registry r -> Registry r

fallbackRoute :: ([Text] -> RouteAppliedAction r) -> Registry r -> Registry r

matchRoute :: Registry r -> [Text] -> [(ParamMap, RouteAppliedAction r)]

Instances

AbstractRouter (TextRouter m a)

AbstractRouter (SafeRouter m a)

type ParamMap = HashMap CaptureVar Text

newtype CaptureVar

Constructors

CaptureVar

Fields

unCaptureVar :: Text

Instances

Eq CaptureVar

Show CaptureVar

NFData CaptureVar

Hashable CaptureVar

newtype RegistryT r middleware reqTypes m a

Constructors

RegistryT

Fields

runRegistryT :: RWST (RoutePath r []) [middleware] (RegistryState r reqTypes) m a

Instances

Monad m => MonadWriter [middleware] (RegistryT r middleware reqTypes m)

Monad m => MonadReader (RoutePath r ([] *)) (RegistryT r middleware reqTypes m)

Monad m => MonadState (RegistryState r reqTypes) (RegistryT r middleware reqTypes m)

MonadTrans (RegistryT r middleware reqTypes)

Monad m => Monad (RegistryT r middleware reqTypes m)

Functor m => Functor (RegistryT r middleware reqTypes m)

(Monad m, Functor m) => Applicative (RegistryT r middleware reqTypes m)

MonadIO m => MonadIO (RegistryT r middleware reqTypes m)

data RegistryState r reqTypes

Constructors

RegistryState

Fields

rs_registry :: HashMap reqTypes (Registry r)

Instances

Monad m => MonadState (RegistryState r reqTypes) (RegistryT r middleware reqTypes m)

hookAny :: (Monad m, AbstractRouter r, Eq reqTypes, Hashable reqTypes) => reqTypes -> ([Text] -> RouteAppliedAction r) -> RegistryT r middleware reqTypes m ()

hookRoute :: (Monad m, AbstractRouter r, Eq reqTypes, Hashable reqTypes) => reqTypes -> RoutePath r as -> RouteAction r as -> RegistryT r middleware reqTypes m ()

middleware :: Monad m => middleware -> RegistryT r middleware reqTypes m ()

subcomponent :: (Monad m, AbstractRouter r) => RoutePath r [] -> RegistryT r middleware reqTypes m a -> RegistryT r middleware reqTypes m a

runRegistry :: (Monad m, AbstractRouter r, Hashable reqTypes, Eq reqTypes) => r -> RegistryT r middleware reqTypes m a -> m (a, reqTypes -> [Text] -> [(ParamMap, RouteAppliedAction r)], [middleware])