Hreq.Core.API

This module re-exports types and combinators required for type level construction of API request components and expected type structure of an http request response.

Request

module Hreq.Core.API.Request

Response

module Hreq.Core.API.Response

API Types and Kinds

module Hreq.Core.API.Internal

MediaType

module Hreq.Core.API.MediaType

Streaming

module Hreq.Core.API.Streaming

TypeLevel

module Hreq.Core.API.TypeLevel

Verb

module Hreq.Core.API.Verb

API Type Synonyms

type EmptyResponse v = Verb v ('[] :: [ResContent Type])

type RawResponse v = Verb v '[Raw]

type DeleteJson a = Delete '[ResBody JSON a]

type PatchJson a = Patch '[ResBody JSON a]

type PutJson a = Put '[ResBody JSON a]

type PostJson a = Post '[ResBody JSON a]

type GetJson a = Get '[ResBody JSON a]

Response Type synonyms

type JsonBody (a :: Type) = ReqBody JSON a

type StatusCode = Int

Re-exports

class ToHttpApiData a where

Convert value to HTTP API data.

WARNING: Do not derive this using DeriveAnyClass as the generated instance will loop indefinitely.

Minimal complete definition

toUrlPiece | toQueryParam

Methods

toUrlPiece :: a -> Text

Convert to URL path piece.

toEncodedUrlPiece :: a -> Builder

Convert to a URL path piece, making sure to encode any special chars. The default definition uses encodePathSegmentsRelative, but this may be overriden with a more efficient version.

toHeader :: a -> ByteString

Convert to HTTP header value.

toQueryParam :: a -> Text

Convert to query param value.

Instances

ToHttpApiData Bool

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Bool -> Text

toEncodedUrlPiece :: Bool -> Builder

toHeader :: Bool -> ByteString

toQueryParam :: Bool -> Text

ToHttpApiData Char

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Char -> Text

toEncodedUrlPiece :: Char -> Builder

toHeader :: Char -> ByteString

toQueryParam :: Char -> Text

ToHttpApiData Double

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Double -> Text

toEncodedUrlPiece :: Double -> Builder

toHeader :: Double -> ByteString

toQueryParam :: Double -> Text

ToHttpApiData Float

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Float -> Text

toEncodedUrlPiece :: Float -> Builder

toHeader :: Float -> ByteString

toQueryParam :: Float -> Text

ToHttpApiData Int

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Int -> Text

toEncodedUrlPiece :: Int -> Builder

toHeader :: Int -> ByteString

toQueryParam :: Int -> Text

ToHttpApiData Int8

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Int8 -> Text

toEncodedUrlPiece :: Int8 -> Builder

toHeader :: Int8 -> ByteString

toQueryParam :: Int8 -> Text

ToHttpApiData Int16

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Int16 -> Text

toEncodedUrlPiece :: Int16 -> Builder

toHeader :: Int16 -> ByteString

toQueryParam :: Int16 -> Text

ToHttpApiData Int32

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Int32 -> Text

toEncodedUrlPiece :: Int32 -> Builder

toHeader :: Int32 -> ByteString

toQueryParam :: Int32 -> Text

ToHttpApiData Int64

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Int64 -> Text

toEncodedUrlPiece :: Int64 -> Builder

toHeader :: Int64 -> ByteString

toQueryParam :: Int64 -> Text

ToHttpApiData Integer

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Integer -> Text

toEncodedUrlPiece :: Integer -> Builder

toHeader :: Integer -> ByteString

toQueryParam :: Integer -> Text

ToHttpApiData Natural

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Natural -> Text

toEncodedUrlPiece :: Natural -> Builder

toHeader :: Natural -> ByteString

toQueryParam :: Natural -> Text

ToHttpApiData Ordering

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Ordering -> Text

toEncodedUrlPiece :: Ordering -> Builder

toHeader :: Ordering -> ByteString

toQueryParam :: Ordering -> Text

ToHttpApiData Word

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Word -> Text

toEncodedUrlPiece :: Word -> Builder

toHeader :: Word -> ByteString

toQueryParam :: Word -> Text

ToHttpApiData Word8

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Word8 -> Text

toEncodedUrlPiece :: Word8 -> Builder

toHeader :: Word8 -> ByteString

toQueryParam :: Word8 -> Text

ToHttpApiData Word16

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Word16 -> Text

toEncodedUrlPiece :: Word16 -> Builder

toHeader :: Word16 -> ByteString

toQueryParam :: Word16 -> Text

ToHttpApiData Word32

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Word32 -> Text

toEncodedUrlPiece :: Word32 -> Builder

toHeader :: Word32 -> ByteString

toQueryParam :: Word32 -> Text

ToHttpApiData Word64

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Word64 -> Text

toEncodedUrlPiece :: Word64 -> Builder

toHeader :: Word64 -> ByteString

toQueryParam :: Word64 -> Text

ToHttpApiData ()

>>> toUrlPiece ()
"_"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: () -> Text

toEncodedUrlPiece :: () -> Builder

toHeader :: () -> ByteString

toQueryParam :: () -> Text

ToHttpApiData Void

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Void -> Text

toEncodedUrlPiece :: Void -> Builder

toHeader :: Void -> ByteString

toQueryParam :: Void -> Text

ToHttpApiData Version

>>> toUrlPiece (Version [1, 2, 3] [])
"1.2.3"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Version -> Text

toEncodedUrlPiece :: Version -> Builder

toHeader :: Version -> ByteString

toQueryParam :: Version -> Text

ToHttpApiData All

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: All -> Text

toEncodedUrlPiece :: All -> Builder

toHeader :: All -> ByteString

toQueryParam :: All -> Text

ToHttpApiData Any

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Any -> Text

toEncodedUrlPiece :: Any -> Builder

toHeader :: Any -> ByteString

toQueryParam :: Any -> Text

ToHttpApiData String

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: String -> Text

toEncodedUrlPiece :: String -> Builder

toHeader :: String -> ByteString

toQueryParam :: String -> Text

ToHttpApiData UTCTime

>>> toUrlPiece $ UTCTime (fromGregorian 2015 10 03) 864.5
"2015-10-03T00:14:24.5Z"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: UTCTime -> Text

toEncodedUrlPiece :: UTCTime -> Builder

toHeader :: UTCTime -> ByteString

toQueryParam :: UTCTime -> Text

ToHttpApiData SetCookie

Note: this instance works correctly for alphanumeric name and value

>>> let Right c = parseUrlPiece "SESSID=r2t5uvjq435r4q7ib3vtdjq120" :: Either Text SetCookie
>>> toUrlPiece c
"SESSID=r2t5uvjq435r4q7ib3vtdjq120"

>>> toHeader c
"SESSID=r2t5uvjq435r4q7ib3vtdjq120"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: SetCookie -> Text

toEncodedUrlPiece :: SetCookie -> Builder

toHeader :: SetCookie -> ByteString

toQueryParam :: SetCookie -> Text

ToHttpApiData Text

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Text -> Text

toEncodedUrlPiece :: Text -> Builder

toHeader :: Text -> ByteString

toQueryParam :: Text -> Text

ToHttpApiData UUID

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: UUID -> Text

toEncodedUrlPiece :: UUID -> Builder

toHeader :: UUID -> ByteString

toQueryParam :: UUID -> Text

ToHttpApiData ZonedTime

>>> toUrlPiece $ ZonedTime (LocalTime (fromGregorian 2015 10 03) (TimeOfDay 14 55 51.001)) utc
"2015-10-03T14:55:51.001+0000"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: ZonedTime -> Text

toEncodedUrlPiece :: ZonedTime -> Builder

toHeader :: ZonedTime -> ByteString

toQueryParam :: ZonedTime -> Text

ToHttpApiData LocalTime

>>> toUrlPiece $ LocalTime (fromGregorian 2015 10 03) (TimeOfDay 14 55 21.687)
"2015-10-03T14:55:21.687"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: LocalTime -> Text

toEncodedUrlPiece :: LocalTime -> Builder

toHeader :: LocalTime -> ByteString

toQueryParam :: LocalTime -> Text

ToHttpApiData TimeOfDay

>>> toUrlPiece $ TimeOfDay 14 55 23.1
"14:55:23.1"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: TimeOfDay -> Text

toEncodedUrlPiece :: TimeOfDay -> Builder

toHeader :: TimeOfDay -> ByteString

toQueryParam :: TimeOfDay -> Text

ToHttpApiData NominalDiffTime

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: NominalDiffTime -> Text

toEncodedUrlPiece :: NominalDiffTime -> Builder

toHeader :: NominalDiffTime -> ByteString

toQueryParam :: NominalDiffTime -> Text

ToHttpApiData Day

>>> toUrlPiece (fromGregorian 2015 10 03)
"2015-10-03"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Day -> Text

toEncodedUrlPiece :: Day -> Builder

toHeader :: Day -> ByteString

toQueryParam :: Day -> Text

ToHttpApiData DayOfWeek

>>> toUrlPiece Monday
"monday"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: DayOfWeek -> Text

toEncodedUrlPiece :: DayOfWeek -> Builder

toHeader :: DayOfWeek -> ByteString

toQueryParam :: DayOfWeek -> Text

ToHttpApiData Text

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Text -> Text0

toEncodedUrlPiece :: Text -> Builder

toHeader :: Text -> ByteString

toQueryParam :: Text -> Text0

ToHttpApiData a => ToHttpApiData (Maybe a)

>>> toUrlPiece (Just "Hello")
"just Hello"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Maybe a -> Text

toEncodedUrlPiece :: Maybe a -> Builder

toHeader :: Maybe a -> ByteString

toQueryParam :: Maybe a -> Text

HasResolution a => ToHttpApiData (Fixed a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Fixed a -> Text

toEncodedUrlPiece :: Fixed a -> Builder

toHeader :: Fixed a -> ByteString

toQueryParam :: Fixed a -> Text

ToHttpApiData a => ToHttpApiData (Min a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Min a -> Text

toEncodedUrlPiece :: Min a -> Builder

toHeader :: Min a -> ByteString

toQueryParam :: Min a -> Text

ToHttpApiData a => ToHttpApiData (Max a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Max a -> Text

toEncodedUrlPiece :: Max a -> Builder

toHeader :: Max a -> ByteString

toQueryParam :: Max a -> Text

ToHttpApiData a => ToHttpApiData (First a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: First a -> Text

toEncodedUrlPiece :: First a -> Builder

toHeader :: First a -> ByteString

toQueryParam :: First a -> Text

ToHttpApiData a => ToHttpApiData (Last a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Last a -> Text

toEncodedUrlPiece :: Last a -> Builder

toHeader :: Last a -> ByteString

toQueryParam :: Last a -> Text

ToHttpApiData a => ToHttpApiData (First a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: First a -> Text

toEncodedUrlPiece :: First a -> Builder

toHeader :: First a -> ByteString

toQueryParam :: First a -> Text

ToHttpApiData a => ToHttpApiData (Last a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Last a -> Text

toEncodedUrlPiece :: Last a -> Builder

toHeader :: Last a -> ByteString

toQueryParam :: Last a -> Text

ToHttpApiData a => ToHttpApiData (Dual a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Dual a -> Text

toEncodedUrlPiece :: Dual a -> Builder

toHeader :: Dual a -> ByteString

toQueryParam :: Dual a -> Text

ToHttpApiData a => ToHttpApiData (Sum a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Sum a -> Text

toEncodedUrlPiece :: Sum a -> Builder

toHeader :: Sum a -> ByteString

toQueryParam :: Sum a -> Text

ToHttpApiData a => ToHttpApiData (Product a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Product a -> Text

toEncodedUrlPiece :: Product a -> Builder

toHeader :: Product a -> ByteString

toQueryParam :: Product a -> Text

(ToHttpApiData a, ToHttpApiData b) => ToHttpApiData (Either a b)

>>> toUrlPiece (Left "err" :: Either String Int)
"left err"
>>> toUrlPiece (Right 3 :: Either String Int)
"right 3"

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Either a b -> Text

toEncodedUrlPiece :: Either a b -> Builder

toHeader :: Either a b -> ByteString

toQueryParam :: Either a b -> Text

ToHttpApiData a => ToHttpApiData (Tagged b a)

Defined in Web.Internal.HttpApiData

Methods

toUrlPiece :: Tagged b a -> Text

toEncodedUrlPiece :: Tagged b a -> Builder

toHeader :: Tagged b a -> ByteString

toQueryParam :: Tagged b a -> Text

type Header = (HeaderName, ByteString)

Header

data Status

HTTP Status.

Only the statusCode is used for comparisons.

Please use mkStatus to create status codes from code and message, or the Enum instance or the status code constants (like ok200). There might be additional record members in the future.

Note that the Show instance is only for debugging.

Constructors

Status

Fields

• statusCode :: Int
• statusMessage :: ByteString

Instances

Bounded Status

Defined in Network.HTTP.Types.Status

Methods

minBound :: Status

maxBound :: Status

Enum Status

Defined in Network.HTTP.Types.Status

Methods

succ :: Status -> Status

pred :: Status -> Status

toEnum :: Int -> Status

fromEnum :: Status -> Int

enumFrom :: Status -> [Status]

enumFromThen :: Status -> Status -> [Status]

enumFromTo :: Status -> Status -> [Status]

enumFromThenTo :: Status -> Status -> Status -> [Status]

Eq Status

Defined in Network.HTTP.Types.Status

Methods

(==) :: Status -> Status -> Bool

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

Ord Status

Defined in Network.HTTP.Types.Status

Methods

compare :: Status -> Status -> Ordering

(<) :: Status -> Status -> Bool

(<=) :: Status -> Status -> Bool

(>) :: Status -> Status -> Bool

(>=) :: Status -> Status -> Bool

max :: Status -> Status -> Status

min :: Status -> Status -> Status

Show Status

Defined in Network.HTTP.Types.Status

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

type HeaderName = CI ByteString

Header name