Network.HTTP.Barf.Internal

exported

newtype Req

The type of request modifications. The most important features of this type are the Monoid, Semigroup and IsList instances.

Constructors

MkReq

Fields

• appReq :: Req' -> Req'

Instances

Monoid Req

the empty Req does nothing to the "base" request

Defined in Network.HTTP.Barf.Internal

Methods

mempty :: Req

mappend :: Req -> Req -> Req

mconcat :: [Req] -> Req

Semigroup Req

combining to Reqs composes the extensions to the request

Defined in Network.HTTP.Barf.Internal

Methods

(<>) :: Req -> Req -> Req

sconcat :: NonEmpty Req -> Req

stimes :: Integral b => b -> Req -> Req

IsList Req

An IsList instance for Req makes it easy to combine multiple Reqs monoidally by passing them in list syntax. The idea is that it composes all of the request extensions in the list it gets passed

Even though toList = singleton, this instance does adhere to the laws of the IsList type class

Defined in Network.HTTP.Barf.Internal

Associated Types

type Item Req

Methods

fromList :: [Item Req] -> Req

fromListN :: Int -> [Item Req] -> Req

toList :: Req -> [Item Req]

type Item Req

Defined in Network.HTTP.Barf.Internal

type Item Req = Req

get_

Arguments

:: MonadIO m

=> String

the url to connect to

-> Req

the modifier(s) to the request

-> m LazyByteString

creates a GET request, use it like

get_ "http://localhost:8080" []

head_

Arguments

:: MonadIO m

=> String

the url to connect to

-> Req

the modifier(s) to the request

-> m LazyByteString

creates a HEAD request, use it like

head_ "http://localhost:8080" []

post_

Arguments

:: MonadIO m

=> String

the url to connect to

-> Req

the modifier(s) to the request

-> m LazyByteString

creates a POST request, use it like

post_ "http://localhost:8080" []

put_

Arguments

:: MonadIO m

=> String

the url to connect to

-> Req

the modifier(s) to the request

-> m LazyByteString

creates a PUT request, use it like

put_ "http://localhost:8080" []

delete_

Arguments

:: MonadIO m

=> String

the url to connect to

-> Req

the modifier(s) to the request

-> m LazyByteString

creates a DELETE request, use it like

delete_ "http://localhost:8080" []

q_

Arguments

:: String

the name of the query param

-> String

the value of the query param

-> Req

q_ like "query"

h_

Arguments

:: String

the name of the header

-> String

the value of the header

-> Req

h_ like "header"

j_

Arguments

:: ToJSON a

=> a

the value of the json body

-> Req

j_ like "json"

if the json body is already set, it will be overwritten

v_

Arguments

:: Value

the value of the json body

-> Req

v_ like "value"

this is a convenience helper for using j_ specialised to Value. It is useful if you just want to quickly build a json body for your request.

if the json body is already set, it will be overwritten

inspectRequest_ :: Req

print the request before dispatching, useful for debugging

dryRun_ :: Req

when set, do not execute the request

internal

httpWithManager :: MonadIO m => StrictByteString -> String -> Req -> m LazyByteString

buildRequestFromReq :: StrictByteString -> String -> Req' -> IO Request

data Req'

a data type representing an http request

Constructors

MkReq'

Fields

• queryParams :: Vector (String, String)
• headers :: Vector (String, String)
• jsonBody :: Maybe Value
• inspectRequest :: Bool
• dryRun :: Bool

Instances

Generic Req'

Defined in Network.HTTP.Barf.Internal

Associated Types

type Rep Req' :: Type -> Type

Methods

from :: Req' -> Rep Req' x

to :: Rep Req' x -> Req'

Show Req'

Defined in Network.HTTP.Barf.Internal

Methods

showsPrec :: Int -> Req' -> ShowS

show :: Req' -> String

showList :: [Req'] -> ShowS

Eq Req'

Defined in Network.HTTP.Barf.Internal

Methods

(==) :: Req' -> Req' -> Bool

(/=) :: Req' -> Req' -> Bool

Ord Req'

Defined in Network.HTTP.Barf.Internal

Methods

compare :: Req' -> Req' -> Ordering

(<) :: Req' -> Req' -> Bool

(<=) :: Req' -> Req' -> Bool

(>) :: Req' -> Req' -> Bool

(>=) :: Req' -> Req' -> Bool

max :: Req' -> Req' -> Req'

min :: Req' -> Req' -> Req'

type Rep Req'

Defined in Network.HTTP.Barf.Internal

type Rep Req' = D1 ('MetaData "Req'" "Network.HTTP.Barf.Internal" "http-barf-0.1.1.0-inplace" 'False) (C1 ('MetaCons "MkReq'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queryParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector (String, String))) :*: S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector (String, String)))) :*: (S1 ('MetaSel ('Just "jsonBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Value)) :*: (S1 ('MetaSel ('Just "inspectRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

defaultReq' :: Req'