servant
Safe HaskellNone
LanguageHaskell2010

Servant.API.Verbs

Synopsis

Documentation

type Delete = Verb 'DELETE 200 Source #

DELETE with 200 status code.

type DeleteAccepted = Verb 'DELETE 202 Source #

DELETE with 202 status code.

type DeleteNoContent = NoContentVerb 'DELETE Source #

DELETE with 204 status code.

type DeleteNonAuthoritative = Verb 'DELETE 203 Source #

DELETE with 203 status code.

type DeleteResetContent = Verb 'DELETE 205 Source #

DELETE with 205 status code.

type Get = Verb 'GET 200 Source #

GET with 200 status code.

type GetAccepted = Verb 'GET 202 Source #

GET with 202 status code.

type GetNoContent = NoContentVerb 'GET Source #

GET with 204 status code.

type GetNonAuthoritative = Verb 'GET 203 Source #

GET with 203 status code.

type GetPartialContent = Verb 'GET 206 Source #

GET with 206 status code.

type GetResetContent = Verb 'GET 205 Source #

GET with 205 status code.

type HeadNoContent = NoContentVerb 'HEAD Source #

HEAD with 204 status code.

data NoContentVerb (method :: k1) Source #

NoContentVerb is a specific type to represent NoContent responses. It does not require either a list of content types (because there's no content) or a status code (because it should always be 204).

Instances

Instances details
HasLink (NoContentVerb m :: Type) Source # 
Instance details

Defined in Servant.Links

Methods

toLink :: (Link -> a) -> Proxy (NoContentVerb m) -> Link -> MkLink (NoContentVerb m) a Source #

Generic (NoContentVerb method) Source # 
Instance details

Defined in Servant.API.Verbs

Associated Types

type Rep (NoContentVerb method) 
Instance details

Defined in Servant.API.Verbs

type Rep (NoContentVerb method) = D1 ('MetaData "NoContentVerb" "Servant.API.Verbs" "servant-0.20.2-AUAQrK4N4gFBaOWvOIVR2f" 'False) (V1 :: Type -> Type)

Methods

from :: NoContentVerb method -> Rep (NoContentVerb method) x #

to :: Rep (NoContentVerb method) x -> NoContentVerb method #

type MkLink (NoContentVerb m :: Type) r Source # 
Instance details

Defined in Servant.Links

type MkLink (NoContentVerb m :: Type) r = r
type Rep (NoContentVerb method) Source # 
Instance details

Defined in Servant.API.Verbs

type Rep (NoContentVerb method) = D1 ('MetaData "NoContentVerb" "Servant.API.Verbs" "servant-0.20.2-AUAQrK4N4gFBaOWvOIVR2f" 'False) (V1 :: Type -> Type)

type Patch = Verb 'PATCH 200 Source #

PATCH with 200 status code.

type PatchAccepted = Verb 'PATCH 202 Source #

PATCH with 202 status code.

type PatchNoContent = NoContentVerb 'PATCH Source #

PATCH with 204 status code.

type PatchNonAuthoritative = Verb 'PATCH 203 Source #

PATCH with 203 status code.

type PatchResetContent = Verb 'PATCH 205 Source #

PATCH with 205 status code.

type Post = Verb 'POST 200 Source #

POST with 200 status code.

type PostAccepted = Verb 'POST 202 Source #

POST with 202 status code.

type PostCreated = Verb 'POST 201 Source #

POST with 201 status code.

type PostNoContent = NoContentVerb 'POST Source #

POST with 204 status code.

type PostNonAuthoritative = Verb 'POST 203 Source #

POST with 203 status code.

type PostResetContent = Verb 'POST 205 Source #

POST with 205 status code.

type Put = Verb 'PUT 200 Source #

PUT with 200 status code.

type PutAccepted = Verb 'PUT 202 Source #

PUT with 202 status code.

type PutCreated = Verb 'PUT 201 Source #

PUT with 201 status code.

type PutNoContent = NoContentVerb 'PUT Source #

PUT with 204 status code.

type PutNonAuthoritative = Verb 'PUT 203 Source #

PUT with 203 status code.

type PutResetContent = Verb 'PUT 205 Source #

PUT with 205 status code.

class ReflectMethod (a :: k) where Source #

Methods

reflectMethod :: Proxy a -> Method Source #

Instances

Instances details
ReflectMethod 'CONNECT Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'CONNECT -> Method Source #

ReflectMethod 'DELETE Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'DELETE -> Method Source #

ReflectMethod 'GET Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'GET -> Method Source #

ReflectMethod 'HEAD Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'HEAD -> Method Source #

ReflectMethod 'OPTIONS Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'OPTIONS -> Method Source #

ReflectMethod 'PATCH Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'PATCH -> Method Source #

ReflectMethod 'POST Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'POST -> Method Source #

ReflectMethod 'PUT Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'PUT -> Method Source #

ReflectMethod 'TRACE Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'TRACE -> Method Source #

data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [Type]) a Source #

Verb is a general type for representing HTTP verbs (a.k.a. methods). For convenience, type synonyms for each verb with a 200 response code are provided, but you are free to define your own:

>>> type Post204 contentTypes a = Verb 'POST 204 contentTypes a

Instances

Instances details
HasLink (Verb m s ct a :: Type) Source # 
Instance details

Defined in Servant.Links

Methods

toLink :: (Link -> a0) -> Proxy (Verb m s ct a) -> Link -> MkLink (Verb m s ct a) a0 Source #

Generic (Verb method statusCode contentTypes a) Source # 
Instance details

Defined in Servant.API.Verbs

Associated Types

type Rep (Verb method statusCode contentTypes a) 
Instance details

Defined in Servant.API.Verbs

type Rep (Verb method statusCode contentTypes a) = D1 ('MetaData "Verb" "Servant.API.Verbs" "servant-0.20.2-AUAQrK4N4gFBaOWvOIVR2f" 'False) (V1 :: Type -> Type)

Methods

from :: Verb method statusCode contentTypes a -> Rep (Verb method statusCode contentTypes a) x #

to :: Rep (Verb method statusCode contentTypes a) x -> Verb method statusCode contentTypes a #

AtMostOneFragment (Verb m s ct typ) Source # 
Instance details

Defined in Servant.API.TypeLevel

type MkLink (Verb m s ct a :: Type) r Source # 
Instance details

Defined in Servant.Links

type MkLink (Verb m s ct a :: Type) r = r
type Rep (Verb method statusCode contentTypes a) Source # 
Instance details

Defined in Servant.API.Verbs

type Rep (Verb method statusCode contentTypes a) = D1 ('MetaData "Verb" "Servant.API.Verbs" "servant-0.20.2-AUAQrK4N4gFBaOWvOIVR2f" 'False) (V1 :: Type -> Type)

data StdMethod Source #

HTTP standard method (as defined by RFC 2616, and PATCH which is defined by RFC 5789).

Since: http-types-0.2.0

Constructors

GET 
POST 
HEAD 
PUT 
DELETE 
TRACE 
CONNECT 
OPTIONS 
PATCH

Since: http-types-0.8.0

Instances

Instances details
Data StdMethod Source #

Since: http-types-0.12.4

Instance details

Defined in Network.HTTP.Types.Method

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StdMethod -> c StdMethod #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StdMethod #

toConstr :: StdMethod -> Constr #

dataTypeOf :: StdMethod -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StdMethod) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StdMethod) #

gmapT :: (forall b. Data b => b -> b) -> StdMethod -> StdMethod #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StdMethod -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StdMethod -> r #

gmapQ :: (forall d. Data d => d -> u) -> StdMethod -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StdMethod -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StdMethod -> m StdMethod #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StdMethod -> m StdMethod #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StdMethod -> m StdMethod #

Bounded StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

minBound :: StdMethod #

maxBound :: StdMethod #

Enum StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

succ :: StdMethod -> StdMethod #

pred :: StdMethod -> StdMethod #

toEnum :: Int -> StdMethod #

fromEnum :: StdMethod -> Int #

enumFrom :: StdMethod -> [StdMethod] #

enumFromThen :: StdMethod -> StdMethod -> [StdMethod] #

enumFromTo :: StdMethod -> StdMethod -> [StdMethod] #

enumFromThenTo :: StdMethod -> StdMethod -> StdMethod -> [StdMethod] #

Generic StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Associated Types

type Rep StdMethod

Since: http-types-0.12.4

Instance details

Defined in Network.HTTP.Types.Method

type Rep StdMethod = D1 ('MetaData "StdMethod" "Network.HTTP.Types.Method" "http-types-0.12.4-69AV8PThAU05MVGAqv87i1" 'False) (((C1 ('MetaCons "GET" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "POST" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HEAD" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PUT" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DELETE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TRACE" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CONNECT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OPTIONS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PATCH" 'PrefixI 'False) (U1 :: Type -> Type)))))

Methods

from :: StdMethod -> Rep StdMethod x #

to :: Rep StdMethod x -> StdMethod #

Ix StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

range :: (StdMethod, StdMethod) -> [StdMethod] #

index :: (StdMethod, StdMethod) -> StdMethod -> Int #

unsafeIndex :: (StdMethod, StdMethod) -> StdMethod -> Int #

inRange :: (StdMethod, StdMethod) -> StdMethod -> Bool #

rangeSize :: (StdMethod, StdMethod) -> Int #

unsafeRangeSize :: (StdMethod, StdMethod) -> Int #

Read StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

readsPrec :: Int -> ReadS StdMethod #

readList :: ReadS [StdMethod] #

readPrec :: ReadPrec StdMethod #

readListPrec :: ReadPrec [StdMethod] #

Show StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

showsPrec :: Int -> StdMethod -> ShowS #

show :: StdMethod -> String #

showList :: [StdMethod] -> ShowS #

Eq StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

(==) :: StdMethod -> StdMethod -> Bool #

(/=) :: StdMethod -> StdMethod -> Bool #

Ord StdMethod Source # 
Instance details

Defined in Network.HTTP.Types.Method

Methods

compare :: StdMethod -> StdMethod -> Ordering #

(<) :: StdMethod -> StdMethod -> Bool #

(<=) :: StdMethod -> StdMethod -> Bool #

(>) :: StdMethod -> StdMethod -> Bool #

(>=) :: StdMethod -> StdMethod -> Bool #

max :: StdMethod -> StdMethod -> StdMethod #

min :: StdMethod -> StdMethod -> StdMethod #

ReflectMethod 'CONNECT Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'CONNECT -> Method Source #

ReflectMethod 'DELETE Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'DELETE -> Method Source #

ReflectMethod 'GET Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'GET -> Method Source #

ReflectMethod 'HEAD Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'HEAD -> Method Source #

ReflectMethod 'OPTIONS Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'OPTIONS -> Method Source #

ReflectMethod 'PATCH Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'PATCH -> Method Source #

ReflectMethod 'POST Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'POST -> Method Source #

ReflectMethod 'PUT Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'PUT -> Method Source #

ReflectMethod 'TRACE Source # 
Instance details

Defined in Servant.API.Verbs

Methods

reflectMethod :: Proxy 'TRACE -> Method Source #

type Rep StdMethod Source #

Since: http-types-0.12.4

Instance details

Defined in Network.HTTP.Types.Method

type Rep StdMethod = D1 ('MetaData "StdMethod" "Network.HTTP.Types.Method" "http-types-0.12.4-69AV8PThAU05MVGAqv87i1" 'False) (((C1 ('MetaCons "GET" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "POST" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HEAD" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PUT" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DELETE" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TRACE" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "CONNECT" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OPTIONS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PATCH" 'PrefixI 'False) (U1 :: Type -> Type)))))