Safe Haskell	None
Language	Haskell2010

Hreq.Core.API

Contents

Request
Response
API Types and Kinds
MediaType
Streaming
TypeLevel
Verb
API Type Synonyms
Re-exports

Description

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.

Synopsis

module Hreq.Core.API.Request
module Hreq.Core.API.Response
module Hreq.Core.API.Internal
module Hreq.Core.API.MediaType
module Hreq.Core.API.Streaming
module Hreq.Core.API.TypeLevel
module Hreq.Core.API.Verb
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]
type JsonBody (a :: Type) = ReqBody JSON a
type StatusCode = Int
class ToHttpApiData a where
- toUrlPiece :: a -> Text
- toEncodedUrlPiece :: a -> Builder
- toHeader :: a -> ByteString
- toQueryParam :: a -> Text
type Header = (HeaderName, ByteString)
data Status = Status {
- statusCode :: Int
- statusMessage :: ByteString
}
type HeaderName = CI ByteString

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]) Source #

type RawResponse v = Verb v '[Raw] Source #

type DeleteJson a = Delete '[ResBody JSON a] Source #

type PatchJson a = Patch '[ResBody JSON a] Source #

type PutJson a = Put '[ResBody JSON a] Source #

type PostJson a = Post '[ResBody JSON a] Source #

type GetJson a = Get '[ResBody JSON a] Source #

Response Type synonyms

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

type StatusCode = Int Source #

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
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Bool -> Text # toEncodedUrlPiece :: Bool -> Builder # toHeader :: Bool -> ByteString # toQueryParam :: Bool -> Text #
ToHttpApiData Char
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Char -> Text # toEncodedUrlPiece :: Char -> Builder # toHeader :: Char -> ByteString # toQueryParam :: Char -> Text #
ToHttpApiData Double
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Double -> Text # toEncodedUrlPiece :: Double -> Builder # toHeader :: Double -> ByteString # toQueryParam :: Double -> Text #
ToHttpApiData Float
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Float -> Text # toEncodedUrlPiece :: Float -> Builder # toHeader :: Float -> ByteString # toQueryParam :: Float -> Text #
ToHttpApiData Int
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Int -> Text # toEncodedUrlPiece :: Int -> Builder # toHeader :: Int -> ByteString # toQueryParam :: Int -> Text #
ToHttpApiData Int8
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Int8 -> Text # toEncodedUrlPiece :: Int8 -> Builder # toHeader :: Int8 -> ByteString # toQueryParam :: Int8 -> Text #
ToHttpApiData Int16
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Int16 -> Text # toEncodedUrlPiece :: Int16 -> Builder # toHeader :: Int16 -> ByteString # toQueryParam :: Int16 -> Text #
ToHttpApiData Int32
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Int32 -> Text # toEncodedUrlPiece :: Int32 -> Builder # toHeader :: Int32 -> ByteString # toQueryParam :: Int32 -> Text #
ToHttpApiData Int64
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Int64 -> Text # toEncodedUrlPiece :: Int64 -> Builder # toHeader :: Int64 -> ByteString # toQueryParam :: Int64 -> Text #
ToHttpApiData Integer
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Integer -> Text # toEncodedUrlPiece :: Integer -> Builder # toHeader :: Integer -> ByteString # toQueryParam :: Integer -> Text #
ToHttpApiData Natural
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Natural -> Text # toEncodedUrlPiece :: Natural -> Builder # toHeader :: Natural -> ByteString # toQueryParam :: Natural -> Text #
ToHttpApiData Ordering
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Ordering -> Text # toEncodedUrlPiece :: Ordering -> Builder # toHeader :: Ordering -> ByteString # toQueryParam :: Ordering -> Text #
ToHttpApiData Word
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Word -> Text # toEncodedUrlPiece :: Word -> Builder # toHeader :: Word -> ByteString # toQueryParam :: Word -> Text #
ToHttpApiData Word8
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Word8 -> Text # toEncodedUrlPiece :: Word8 -> Builder # toHeader :: Word8 -> ByteString # toQueryParam :: Word8 -> Text #
ToHttpApiData Word16
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Word16 -> Text # toEncodedUrlPiece :: Word16 -> Builder # toHeader :: Word16 -> ByteString # toQueryParam :: Word16 -> Text #
ToHttpApiData Word32
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Word32 -> Text # toEncodedUrlPiece :: Word32 -> Builder # toHeader :: Word32 -> ByteString # toQueryParam :: Word32 -> Text #
ToHttpApiData Word64
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Word64 -> Text # toEncodedUrlPiece :: Word64 -> Builder # toHeader :: Word64 -> ByteString # toQueryParam :: Word64 -> Text #
ToHttpApiData ()	`>>>` `toUrlPiece ()`"_"
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: () -> Text # toEncodedUrlPiece :: () -> Builder # toHeader :: () -> ByteString # toQueryParam :: () -> Text #
ToHttpApiData Void
Instance details 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"
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Version -> Text # toEncodedUrlPiece :: Version -> Builder # toHeader :: Version -> ByteString # toQueryParam :: Version -> Text #
ToHttpApiData All
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: All -> Text # toEncodedUrlPiece :: All -> Builder # toHeader :: All -> ByteString # toQueryParam :: All -> Text #
ToHttpApiData Any
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Any -> Text # toEncodedUrlPiece :: Any -> Builder # toHeader :: Any -> ByteString # toQueryParam :: Any -> Text #
ToHttpApiData String
Instance details 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"
Instance details 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"
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: SetCookie -> Text # toEncodedUrlPiece :: SetCookie -> Builder # toHeader :: SetCookie -> ByteString # toQueryParam :: SetCookie -> Text #
ToHttpApiData Text
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Text -> Text # toEncodedUrlPiece :: Text -> Builder # toHeader :: Text -> ByteString # toQueryParam :: Text -> Text #
ToHttpApiData UUID
Instance details 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"
Instance details 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"
Instance details 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"
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: TimeOfDay -> Text # toEncodedUrlPiece :: TimeOfDay -> Builder # toHeader :: TimeOfDay -> ByteString # toQueryParam :: TimeOfDay -> Text #
ToHttpApiData NominalDiffTime
Instance details 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"
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: Day -> Text # toEncodedUrlPiece :: Day -> Builder # toHeader :: Day -> ByteString # toQueryParam :: Day -> Text #
ToHttpApiData DayOfWeek	`>>>` `toUrlPiece Monday`"monday"
Instance details Defined in Web.Internal.HttpApiData Methods toUrlPiece :: DayOfWeek -> Text # toEncodedUrlPiece :: DayOfWeek -> Builder # toHeader :: DayOfWeek -> ByteString # toQueryParam :: DayOfWeek -> Text #
ToHttpApiData Text
Instance details 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"
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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)
Instance details 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"
Instance details 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)
Instance details 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
Instance details Defined in Network.HTTP.Types.Status Methods minBound :: Status # maxBound :: Status #
Enum Status
Instance details 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
Instance details Defined in Network.HTTP.Types.Status Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
Ord Status
Instance details 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
Instance details Defined in Network.HTTP.Types.Status Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #

type HeaderName = CI ByteString #

Header name