Mig.Core.Class.Route

Creation of routes from functions. A route is a handler function for single path of the server.

Documentation

data Route m

Route contains API-info and how to run it

Constructors

Route

Fields

• info :: RouteInfo

  definition of the API (to use it in OpenApi or clients)

• run :: ServerFun m

  how to run a server

Instances

MonadIO m => ToRoute (Route m)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: Route m -> ServerFun (MonadOf (Route m))

class MonadIO (MonadOf a) => ToRoute a where

Values that represent routes. A route is a function of arbitrary number of arguments. Where each argument is one of the special newtype-wrappers that read type-safe information from HTTP-request and return type of the route function is a value of something convertible to HTTP-request.

Methods

toRouteInfo :: RouteInfo -> RouteInfo

Update API info

toRouteFun :: a -> ServerFun (MonadOf a)

Convert to route

Instances

MonadIO m => ToRoute (Route m)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: Route m -> ServerFun (MonadOf (Route m))

(ToSchema a, FromReqBody media a, ToRoute b) => ToRoute (Body media a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (Body media a -> b) -> ServerFun (MonadOf (Body media a -> b))

(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Capture sym a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (Capture sym a -> b) -> ServerFun (MonadOf (Capture sym a -> b))

(FromForm a, ToRoute b) => ToRoute (Cookie a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (Cookie a -> b) -> ServerFun (MonadOf (Cookie a -> b))

ToRoute b => ToRoute (FullPathInfo -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (FullPathInfo -> b) -> ServerFun (MonadOf (FullPathInfo -> b))

(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Header sym a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (Header sym a -> b) -> ServerFun (MonadOf (Header sym a -> b))

ToRoute b => ToRoute (IsSecure -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (IsSecure -> b) -> ServerFun (MonadOf (IsSecure -> b))

(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Optional sym a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (Optional sym a -> b) -> ServerFun (MonadOf (Optional sym a -> b))

(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (OptionalHeader sym a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (OptionalHeader sym a -> b) -> ServerFun (MonadOf (OptionalHeader sym a -> b))

ToRoute b => ToRoute (PathInfo -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (PathInfo -> b) -> ServerFun (MonadOf (PathInfo -> b))

(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Query sym a -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (Query sym a -> b) -> ServerFun (MonadOf (Query sym a -> b))

(ToRoute b, KnownSymbol sym) => ToRoute (QueryFlag sym -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (QueryFlag sym -> b) -> ServerFun (MonadOf (QueryFlag sym -> b))

ToRoute b => ToRoute (RawRequest -> b)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: (RawRequest -> b) -> ServerFun (MonadOf (RawRequest -> b))

(MonadIO m, IsResp a, IsMethod method) => ToRoute (Send method m a)

Defined in Mig.Core.Class.Route

Methods

toRouteInfo :: RouteInfo -> RouteInfo

toRouteFun :: Send method m a -> ServerFun (MonadOf (Send method m a))

toRoute :: forall a. ToRoute a => a -> Route (MonadOf a)

converts route-like value to route.