Hreq.Core.API.Verb

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

Documentation

class ReflectMethod a where

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

Methods

reflectMethod :: Proxy a -> Method

Instances

ReflectMethod PATCH

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy PATCH -> Method

ReflectMethod OPTIONS

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy OPTIONS -> Method

ReflectMethod CONNECT

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy CONNECT -> Method

ReflectMethod TRACE

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy TRACE -> Method

ReflectMethod DELETE

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy DELETE -> Method

ReflectMethod PUT

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy PUT -> Method

ReflectMethod HEAD

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy HEAD -> Method

ReflectMethod POST

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy POST -> Method

ReflectMethod GET

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy GET -> 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])

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)

Defined in Hreq.Core.Client.HasRequest

Associated Types

type HttpInput ts :: Type

Methods

httpReq :: Proxy (Verb method rs) -> Proxy ts -> HttpInput ts -> Request -> Request

(UniqMembers rs "Response", HasResponse rs m) => HasResponse (Verb method rs :: Type) m

Defined in Hreq.Core.Client.HasResponse

Associated Types

type HttpOutput (Verb method rs) :: Type

Methods

httpRes :: sing (Verb method rs) -> Response -> m (HttpOutput (Verb method rs))

type HttpOutput (Verb method rs :: Type)

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

Defined in Network.HTTP.Types.Method

Methods

minBound :: StdMethod

maxBound :: StdMethod

Enum StdMethod

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

Defined in Network.HTTP.Types.Method

Methods

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

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

Ord StdMethod

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

Defined in Network.HTTP.Types.Method

Methods

readsPrec :: Int -> ReadS StdMethod

readList :: ReadS [StdMethod]

readPrec :: ReadPrec StdMethod

readListPrec :: ReadPrec [StdMethod]

Show StdMethod

Defined in Network.HTTP.Types.Method

Methods

showsPrec :: Int -> StdMethod -> ShowS

show :: StdMethod -> String

showList :: [StdMethod] -> ShowS

Ix StdMethod

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

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy PATCH -> Method

ReflectMethod OPTIONS

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy OPTIONS -> Method

ReflectMethod CONNECT

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy CONNECT -> Method

ReflectMethod TRACE

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy TRACE -> Method

ReflectMethod DELETE

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy DELETE -> Method

ReflectMethod PUT

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy PUT -> Method

ReflectMethod HEAD

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy HEAD -> Method

ReflectMethod POST

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy POST -> Method

ReflectMethod GET

Defined in Hreq.Core.API.Verb

Methods

reflectMethod :: Proxy GET -> Method

type Method = ByteString

HTTP method (flat string type).