Safe Haskell	Safe-Inferred
Language	GHC2021

Mig.Core.Types.Route

Contents

inputs
outputs
- Method tags

Description

Newtype wrappers for route DSL

Synopsis

newtype Body media a = Body a
newtype Query (sym :: Symbol) a = Query a
newtype QueryFlag (sym :: Symbol) = QueryFlag Bool
newtype Optional (sym :: Symbol) a = Optional (Maybe a)
newtype Capture (sym :: Symbol) a = Capture a
newtype Header (sym :: Symbol) a = Header a
newtype OptionalHeader (sym :: Symbol) a = OptionalHeader (Maybe a)
newtype Cookie a = Cookie (Maybe a)
newtype PathInfo = PathInfo [Text]
newtype FullPathInfo = FullPathInfo Text
newtype RawRequest = RawRequest Request
newtype IsSecure = IsSecure Bool
newtype Send method m a = Send {
- unSend :: m a
}
type Get m a = Send GET m a
type Post m a = Send POST m a
type Put m a = Send PUT m a
type Delete m a = Send DELETE m a
type Options m a = Send OPTIONS m a
type Head m a = Send HEAD m a
type Patch m a = Send PATCH m a
type Trace m a = Send TRACE m a
class IsMethod a where
- toMethod :: Method
data GET
data POST
data PUT
data DELETE
data OPTIONS
data HEAD
data PATCH
data TRACE

inputs

newtype Body media a Source #

Generic case for request body. The type encodes a media type and value of the request body.

Constructors

Body a

Instances

Instances details

(FromReqBody ty a, ToSchema a, ToPlugin b) => ToPlugin (Body ty a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (Body ty a -> b) -> ServerFun (MonadOf (Body ty a -> b)) -> ServerFun (MonadOf (Body ty a -> b)) 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 #

newtype Query (sym :: Symbol) a Source #

Required URL parameter query.

"api/route?foo=bar" ==> (Query bar) :: Query "foo" a

Constructors

Query a

Instances

Instances details

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Query sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (Query sym a -> b) -> ServerFun (MonadOf (Query sym a -> b)) -> ServerFun (MonadOf (Query sym a -> 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 #
(KnownSymbol sym, ToHttpApiData a, ToUrl b) => ToUrl (Query sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Url Methods toUrl :: forall (m :: Type -> Type). Server m -> Query sym a -> b Source # mapUrl :: (Url -> Url) -> (Query sym a -> b) -> Query sym a -> b Source # urlArity :: Int Source #

newtype QueryFlag (sym :: Symbol) Source #

Query flag. It is a boolean value in the URL-query. If it is missing it is False if it is in the query but does not have any value it is True. Also it can have values true/false in the query.

Constructors

QueryFlag Bool

Instances

Instances details

(ToPlugin b, KnownSymbol sym) => ToPlugin (QueryFlag sym -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (QueryFlag sym -> b) -> ServerFun (MonadOf (QueryFlag sym -> b)) -> ServerFun (MonadOf (QueryFlag sym -> 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 #
(KnownSymbol sym, ToUrl b) => ToUrl (QueryFlag sym -> b) Source #
Instance details Defined in Mig.Core.Class.Url Methods toUrl :: forall (m :: Type -> Type). Server m -> QueryFlag sym -> b Source # mapUrl :: (Url -> Url) -> (QueryFlag sym -> b) -> QueryFlag sym -> b Source # urlArity :: Int Source #

newtype Optional (sym :: Symbol) a Source #

Optional URL parameter query.

"api/route?foo=bar" ==> (Optional maybeBar) :: Query "foo" a

Constructors

Optional (Maybe a)

Instances

Instances details

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Optional sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (Optional sym a -> b) -> ServerFun (MonadOf (Optional sym a -> b)) -> ServerFun (MonadOf (Optional sym a -> 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 #
(KnownSymbol sym, ToHttpApiData a, ToUrl b) => ToUrl (Optional sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Url Methods toUrl :: forall (m :: Type -> Type). Server m -> Optional sym a -> b Source # mapUrl :: (Url -> Url) -> (Optional sym a -> b) -> Optional sym a -> b Source # urlArity :: Int Source #

newtype Capture (sym :: Symbol) a Source #

Argument of capture from the query.

"api/route/{foo} if api/route/bar passed"  ==> (Capture bar) :: Capture "Foo" barType

Constructors

Capture a

Instances

Instances details

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Capture sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (Capture sym a -> b) -> ServerFun (MonadOf (Capture sym a -> b)) -> ServerFun (MonadOf (Capture sym 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 #
(KnownSymbol sym, ToHttpApiData a, ToUrl b) => ToUrl (Capture sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Url Methods toUrl :: forall (m :: Type -> Type). Server m -> Capture sym a -> b Source # mapUrl :: (Url -> Url) -> (Capture sym a -> b) -> Capture sym a -> b Source # urlArity :: Int Source #

newtype Header (sym :: Symbol) a Source #

Reads value from the required header by name. For example if the request has header:

"foo": "bar"

It reads the value:

(Header bar) :: Header "foo" barType

Constructors

a

Instances

Instances details

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (Header sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (Header sym a -> b) -> ServerFun (MonadOf (Header sym a -> b)) -> ServerFun (MonadOf (Header sym a -> 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 #

newtype OptionalHeader (sym :: Symbol) a Source #

Reads value from the optional header by name. For example if the request has header:

"foo": "bar"

It reads the value:

(OptionalHeader (Just bar)) :: OptionalHeader "foo" barType

Constructors

OptionalHeader (Maybe a)

Instances

Instances details

(FromHttpApiData a, ToParamSchema a, ToPlugin b, KnownSymbol sym) => ToPlugin (OptionalHeader sym a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (OptionalHeader sym a -> b) -> ServerFun (MonadOf (OptionalHeader sym a -> b)) -> ServerFun (MonadOf (OptionalHeader 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 #

newtype Cookie a Source #

Reads a cookie. It's an optional header with name Cookie. The cookie is URL-encoded and read with instnace of FromForm class.

data MyCookie = MyCookie
  { secret :: Text
  , count :: Int
  }
  deriving (Generic, FromForm)

> "secret=lolkek&count=101"

(Cookie (Just (MyCookie { secret = "lolkek", count = 101 }))) :: Cookie MyCookie

Constructors

(Maybe a)

Instances

newtype PathInfo Source #

Reads current path info.

"api/foo/bar" ==> PathInfo ["foo", "bar"]

Constructors

PathInfo [Text]

Instances

Instances details

ToPlugin a => ToPlugin (PathInfo -> a) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (PathInfo -> a) -> ServerFun (MonadOf (PathInfo -> a)) -> ServerFun (MonadOf (PathInfo -> a)) 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 #

newtype FullPathInfo Source #

Reads current full-path info with queries.

"api/foo/bar?param=value" ==> FullPathInfo "api/foo/bar?param=value"

Constructors

FullPathInfo Text

Instances

Instances details

ToPlugin a => ToPlugin (FullPathInfo -> a) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (FullPathInfo -> a) -> ServerFun (MonadOf (FullPathInfo -> a)) -> ServerFun (MonadOf (FullPathInfo -> a)) 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 #

newtype RawRequest Source #

Read low-level request. Note that it does not affect the API schema

Constructors

RawRequest Request

Instances

Instances details

ToPlugin a => ToPlugin (RawRequest -> a) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (RawRequest -> a) -> ServerFun (MonadOf (RawRequest -> a)) -> ServerFun (MonadOf (RawRequest -> a)) 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 #

newtype IsSecure Source #

Reads info on weather the connection is secure (made over SSL).

Constructors

IsSecure Bool

Instances

Instances details

ToPlugin a => ToPlugin (IsSecure -> a) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (IsSecure -> a) -> ServerFun (MonadOf (IsSecure -> a)) -> ServerFun (MonadOf (IsSecure -> a)) 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 #

outputs

newtype Send method m a Source #

Route response type. It encodes the route method in the type and which monad is used and which type the response has.

The repsonse value is usually one of two cases:

Resp media a -- for routes which always produce a value
RespOr media err a - for routes that can also produce an error or value.

See the class IsResp for more details on response types.

Constructors

Send
Fields unSend :: m a

Instances

Instances details

MonadTrans (Send method :: (Type -> Type) -> Type -> Type) Source #
Instance details Defined in Mig.Core.Types.Route Methods lift :: Monad m => m a -> Send method m a #
MonadIO m => MonadIO (Send method m) Source #
Instance details Defined in Mig.Core.Types.Route Methods liftIO :: IO a -> Send method m a #
Applicative m => Applicative (Send method m) Source #
Instance details Defined in Mig.Core.Types.Route Methods pure :: a -> Send method m a # (<>) :: Send method m (a -> b) -> Send method m a -> Send method m b # liftA2 :: (a -> b -> c) -> Send method m a -> Send method m b -> Send method m c # (>) :: Send method m a -> Send method m b -> Send method m b # (<*) :: Send method m a -> Send method m b -> Send method m a #
Functor m => Functor (Send method m) Source #
Instance details Defined in Mig.Core.Types.Route Methods fmap :: (a -> b) -> Send method m a -> Send method m b # (<$) :: a -> Send method m b -> Send method m a #
Monad m => Monad (Send method m) Source #
Instance details Defined in Mig.Core.Types.Route Methods (>>=) :: Send method m a -> (a -> Send method m b) -> Send method m b # (>>) :: Send method m a -> Send method m b -> Send method m b # return :: a -> Send method m a #
(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 #

type Get m a = Send GET m a Source #

Get request

type Post m a = Send POST m a Source #

Post request

type Put m a = Send PUT m a Source #

Put request

type Delete m a = Send DELETE m a Source #

Delete request

type Options m a = Send OPTIONS m a Source #

Options request

type Head m a = Send HEAD m a Source #

Head request

type Patch m a = Send PATCH m a Source #

Path request

type Trace m a = Send TRACE m a Source #

trace request

Method tags

class IsMethod a where Source #

Converts type-level tag for methods to value

Methods

toMethod :: Method Source #

Instances

Instances details

IsMethod DELETE Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod GET Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod HEAD Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod OPTIONS Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod PATCH Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod POST Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod PUT Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #
IsMethod TRACE Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data GET Source #

type-level GET-method tag

Instances

Instances details

IsMethod GET Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data POST Source #

type-level POST-method tag

Instances

Instances details

IsMethod POST Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data PUT Source #

type-level PUT-method tag

Instances

Instances details

IsMethod PUT Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data DELETE Source #

type-level DELETE-method tag

Instances

Instances details

IsMethod DELETE Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data OPTIONS Source #

type-level OPTIONS-method tag

Instances

Instances details

IsMethod OPTIONS Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data HEAD Source #

type-level HEAD-method tag

Instances

Instances details

IsMethod HEAD Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data PATCH Source #

type-level PATCH-method tag

Instances

Instances details

IsMethod PATCH Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

data TRACE Source #

type-level TRACE-method tag

Instances

Instances details

IsMethod TRACE Source #
Instance details Defined in Mig.Core.Types.Route Methods toMethod :: Method Source #

(FromForm a, ToPlugin b) => ToPlugin (Cookie a -> b) Source #
Instance details Defined in Mig.Core.Class.Plugin Methods toPluginInfo :: RouteInfo -> RouteInfo Source # toPluginFun :: (Cookie a -> b) -> ServerFun (MonadOf (Cookie a -> b)) -> ServerFun (MonadOf (Cookie 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 #