Safe Haskell	None
Language	Haskell2010

Hreq.Core.API.Verb

Contents

Re-exports

Description

Module for working with HTTP methods and the resulting content at the type level.

Synopsis

class ReflectMethod a where
- reflectMethod :: Proxy a -> Method
type Patch = Verb PATCH
type PATCH = PATCH
type Delete = Verb DELETE
type DELETE = DELETE
type Put = Verb PUT
type PUT = PUT
type Post = Verb POST
type POST = POST
type Get = Verb GET
type GET = GET
data Verb (method :: k1) (contents :: [k2])
data StdMethod
- = GET
- | POST
- | HEAD
- | PUT
- | DELETE
- | TRACE
- | CONNECT
- | OPTIONS
- | PATCH
type Method = ByteString

Documentation

class ReflectMethod a where Source #

ReflectMethod class provides us with a way to obtain the Method data associated with a promoted HTTP Verb.

Methods

reflectMethod :: Proxy a -> Method Source #

Instances

ReflectMethod PATCH Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy PATCH -> Method Source #
ReflectMethod OPTIONS Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy OPTIONS -> Method Source #
ReflectMethod CONNECT Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy CONNECT -> Method Source #
ReflectMethod TRACE Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy TRACE -> Method Source #
ReflectMethod DELETE Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy DELETE -> Method Source #
ReflectMethod PUT Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy PUT -> Method Source #
ReflectMethod HEAD Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy HEAD -> Method Source #
ReflectMethod POST Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy POST -> Method Source #
ReflectMethod GET Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy GET -> Method Source #

type Patch = Verb PATCH Source #

type PATCH = PATCH Source #

type Delete = Verb DELETE Source #

type DELETE = DELETE Source #

type Put = Verb PUT Source #

type PUT = PUT Source #

type Post = Verb POST Source #

type POST = POST Source #

type Get = Verb GET Source #

type GET = GET Source #

data Verb (method :: k1) (contents :: [k2]) Source #

Verb is a type for representing the results of an HTTP client request call represented as content list and the HTTP method associated with it. Type synonyms for common verbs are provided but you free to define your own

>>> type Trace = Verb 'TRACE

Verb with contents example:

>>> type GetRaw = Verb 'GET '[ Raw ]

Instances

(HttpReqConstraints ts, ReflectMethod method, SingI (Req ts), SingI (Res rs), HttpResConstraints rs) => HasRequest (ts :: [ReqContent Type]) (Verb method rs) Source #
Instance details Defined in Hreq.Core.Client.HasRequest Associated Types type HttpInput ts :: Type Source # Methods httpReq :: Proxy (Verb method rs) -> Proxy ts -> HttpInput ts -> Request -> Request Source #
(UniqMembers rs "Response", HasResponse rs m) => HasResponse (Verb method rs :: Type) m Source #
Instance details Defined in Hreq.Core.Client.HasResponse Associated Types type HttpOutput (Verb method rs) :: Type Source # Methods httpRes :: sing (Verb method rs) -> Response -> m (HttpOutput (Verb method rs)) Source #
type HttpOutput (Verb method rs :: Type) Source #
Instance details Defined in Hreq.Core.Client.HasResponse type HttpOutput (Verb method rs :: Type) = HttpOutput rs

Re-exports

data StdMethod #

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

Constructors

GET
POST
HEAD
PUT
DELETE
TRACE
CONNECT
OPTIONS
PATCH

Instances

Bounded StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods minBound :: StdMethod # maxBound :: StdMethod #
Enum StdMethod
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] #
Eq StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods (==) :: StdMethod -> StdMethod -> Bool # (/=) :: StdMethod -> StdMethod -> Bool #
Ord StdMethod
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 #
Read StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods readsPrec :: Int -> ReadS StdMethod # readList :: ReadS [StdMethod] # readPrec :: ReadPrec StdMethod # readListPrec :: ReadPrec [StdMethod] #
Show StdMethod
Instance details Defined in Network.HTTP.Types.Method Methods showsPrec :: Int -> StdMethod -> ShowS # show :: StdMethod -> String # showList :: [StdMethod] -> ShowS #
Ix StdMethod
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
ReflectMethod PATCH Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy PATCH -> Method Source #
ReflectMethod OPTIONS Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy OPTIONS -> Method Source #
ReflectMethod CONNECT Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy CONNECT -> Method Source #
ReflectMethod TRACE Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy TRACE -> Method Source #
ReflectMethod DELETE Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy DELETE -> Method Source #
ReflectMethod PUT Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy PUT -> Method Source #
ReflectMethod HEAD Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy HEAD -> Method Source #
ReflectMethod POST Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy POST -> Method Source #
ReflectMethod GET Source #
Instance details Defined in Hreq.Core.API.Verb Methods reflectMethod :: Proxy GET -> Method Source #

type Method = ByteString #

HTTP method (flat string type).