Servant.Server.Internal.Router

Documentation

type Router (m :: * -> *) env = Router' m env (RoutingApplication m)

data Router' (m :: * -> *) env a

Internal representation of a router.

Constructors

StaticRouter (Map Text (Router' m env a)) [env -> a]

CaptureRouter (Router' m (Text, env) a)

CaptureAllRouter (Router' m ([Text], env) a)

RawRouter (env -> a)

Choice (Router' m env a) (Router' m env a)

Instances

Functor (Router' m env)

Defined in Servant.Server.Internal.Router

Methods

fmap :: (a -> b) -> Router' m env a -> Router' m env b

(<$) :: a -> Router' m env b -> Router' m env a

pathRouter :: Text -> Router' m env a -> Router' m env a

leafRouter :: (env -> a) -> Router' m env a

choice :: MonadSnap m => Router' m env a -> Router' m env a -> Router' m env a

Smart constructor for the choice between routers. We currently optimize the following cases:

• Two static routers can be joined by joining their maps.
• Two dynamic routers can be joined by joining their codomains.
• Two WithRequest routers can be joined by passing them the same request and joining their codomains.
• A WithRequest router can be joined with anything else by passing the same request to both but ignoring it in the component that does not need it.

data RouterStructure

Constructors

StaticRouterStructure (Map Text RouterStructure) Int

CaptureRouterStructure RouterStructure

RawRouterStructure

ChoiceStructure RouterStructure RouterStructure

Instances

Eq RouterStructure

Defined in Servant.Server.Internal.Router

Methods

(==) :: RouterStructure -> RouterStructure -> Bool

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

Show RouterStructure

Defined in Servant.Server.Internal.Router

Methods

showsPrec :: Int -> RouterStructure -> ShowS

show :: RouterStructure -> String

showList :: [RouterStructure] -> ShowS

routerStructure :: Router' m env a -> RouterStructure

sameStructure :: Router' m env a -> Router' m env b -> Bool

Compare the structure of two routers.

routerLayout :: Router' m env a -> Text

Provide a textual representation of the structure of a router.

tweakResponse :: (RouteResult Response -> RouteResult Response) -> Router m env -> Router m env

Apply a transformation to the response of a Router.

runRouter :: MonadSnap m => Router m () -> RoutingApplication m

runRouterEnv :: MonadSnap m => Router m env -> env -> RoutingApplication m

Interpret a router as an application.

runChoice :: [env -> RoutingApplication m] -> env -> RoutingApplication m

worseHTTPCode :: Int -> Int -> Bool