Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Core.Class.Route

Description

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

Synopsis

data Route m = Route {
- info :: RouteInfo
- run :: ServerFun m
}
class MonadIO (MonadOf a) => ToRoute a where
- toRouteInfo :: RouteInfo -> RouteInfo
- toRouteFun :: a -> ServerFun (MonadOf a)
toRoute :: forall a. ToRoute a => a -> Route (MonadOf a)

Documentation

data Route m Source #

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

Instances details

MonadIO m => ToRoute (Route m) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: Route m -> ServerFun (MonadOf (Route m)) Source #

class MonadIO (MonadOf a) => ToRoute a where Source #

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 Source #

Update API info

toRouteFun :: a -> ServerFun (MonadOf a) Source #

Convert to route

Instances

Instances details

MonadIO m => ToRoute (Route m) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: Route m -> ServerFun (MonadOf (Route m)) Source #
(ToSchema a, FromReqBody media a, ToRoute b) => ToRoute (Body media a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (Body media a -> b) -> ServerFun (MonadOf (Body media a -> b)) Source #
(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Capture sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (Capture sym a -> b) -> ServerFun (MonadOf (Capture sym a -> b)) Source #
(FromForm a, ToRoute b) => ToRoute (Cookie a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (Cookie a -> b) -> ServerFun (MonadOf (Cookie a -> b)) Source #
ToRoute b => ToRoute (FullPathInfo -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (FullPathInfo -> b) -> ServerFun (MonadOf (FullPathInfo -> b)) Source #
(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Header sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (Header sym a -> b) -> ServerFun (MonadOf (Header sym a -> b)) Source #
ToRoute b => ToRoute (IsSecure -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (IsSecure -> b) -> ServerFun (MonadOf (IsSecure -> b)) Source #
(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Optional sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (Optional sym a -> b) -> ServerFun (MonadOf (Optional sym a -> b)) Source #
(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (OptionalHeader sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (OptionalHeader sym a -> b) -> ServerFun (MonadOf (OptionalHeader sym a -> b)) Source #
ToRoute b => ToRoute (PathInfo -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (PathInfo -> b) -> ServerFun (MonadOf (PathInfo -> b)) Source #
(FromHttpApiData a, ToParamSchema a, ToRoute b, KnownSymbol sym) => ToRoute (Query sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (Query sym a -> b) -> ServerFun (MonadOf (Query sym a -> b)) Source #
(ToRoute b, KnownSymbol sym) => ToRoute (QueryFlag sym -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (QueryFlag sym -> b) -> ServerFun (MonadOf (QueryFlag sym -> b)) Source #
ToRoute b => ToRoute (RawRequest -> b) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: (RawRequest -> b) -> ServerFun (MonadOf (RawRequest -> b)) Source #
(MonadIO m, IsResp a, IsMethod method) => ToRoute (Send method m a) Source #
Instance details Defined in Mig.Core.Class.Route Methods toRouteInfo :: RouteInfo -> RouteInfo Source # toRouteFun :: Send method m a -> ServerFun (MonadOf (Send method m a)) Source #

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

converts route-like value to route.