WebGear.Middlewares.Method

Middlewares related to HTTP methods.

Documentation

data Method (t :: StdMethod)

A Trait for capturing the HTTP method of a request

Instances

(IsStdMethod t, Monad m) => Trait (Method t :: Type) Request m

Defined in WebGear.Middlewares.Method

Associated Types

type Attribute (Method t) Request

type Absence (Method t) Request

Methods

toAttribute :: Request -> m (Result (Method t) Request)

type Attribute (Method t :: Type) Request

Defined in WebGear.Middlewares.Method

type Attribute (Method t :: Type) Request = ()

type Absence (Method t :: Type) Request

Defined in WebGear.Middlewares.Method

type Absence (Method t :: Type) Request = MethodMismatch

class IsStdMethod t where

A typeclass to map a StdMethod from type level to term level.

Methods

toStdMethod :: Proxy t -> StdMethod

Convert t to term level.

Instances

IsStdMethod 'PATCH

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'PATCH -> StdMethod

IsStdMethod 'OPTIONS

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'OPTIONS -> StdMethod

IsStdMethod 'CONNECT

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'CONNECT -> StdMethod

IsStdMethod 'TRACE

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'TRACE -> StdMethod

IsStdMethod 'DELETE

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'DELETE -> StdMethod

IsStdMethod 'PUT

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'PUT -> StdMethod

IsStdMethod 'HEAD

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'HEAD -> StdMethod

IsStdMethod 'POST

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'POST -> StdMethod

IsStdMethod 'GET

Defined in WebGear.Middlewares.Method

Methods

toStdMethod :: Proxy 'GET -> StdMethod

data MethodMismatch

Failure to match method against an expected value

Constructors

MethodMismatch

Fields

• expectedMethod :: Method
• actualMethod :: Method

method :: forall t m req a. (IsStdMethod t, MonadRouter m) => RequestMiddleware' m req (Method t ': req) a

A middleware to check whether the request has a specified HTTP method.

Typically this would be used with a type application such as:

method @GET handler

It is also idiomatic to use the template haskell quasiquoter match in cases where both HTTP method and path needs to be matched.