Network.Wreq.Wrecker

This is a copy of the wrecker Session API, Session which utilizes wrecker's record function.

This file was initially copied from Network.Wreq.Session (c) 2014 Bryan O'Sullivan. See the source for the full copy right info.

Documentation

data Session

An opaque type created by withWreq, withWreqNoCookies, or withWreqSettings. All HTTP calls require a Session.

defaultManagerSettings :: ConnectionContext -> ManagerSettings

Create ManagerSettings with no timeout using a shared TLS ConnectionContext

Session Creation

withWreq :: (Session -> IO a) -> Environment -> IO a

Create a Session using the wrecker Environment, passing it to the given function. The Session will no longer be valid after that function returns.

This session manages cookies and uses default session manager configuration.

withWreqNoCookies :: (Session -> IO a) -> Environment -> IO a

Create a session.

This uses the default session manager settings, but does not manage cookies. It is intended for use with REST-like HTTP-based APIs, which typically do not use cookies.

withWreqSettings

Arguments

:: Recorder

-> Maybe CookieJar

If Nothing is specified, no cookie management will be performed.

-> ManagerSettings

-> (Session -> IO a)

-> IO a

Create a session, using the given cookie jar and manager settings.

HTTP Methods

get :: Session -> String -> IO (Response ByteString)

Session-specific version of get.

post :: Postable a => Session -> String -> a -> IO (Response ByteString)

Session-specific version of post.

head_ :: Session -> String -> IO (Response ())

Session-specific version of head_.

options :: Session -> String -> IO (Response ())

Session-specific version of options.

put :: Putable a => Session -> String -> a -> IO (Response ByteString)

Session-specific version of put.

delete :: Session -> String -> IO (Response ByteString)

Session-specific version of delete.

HTTP Methods with Options

getWith :: Options -> Session -> String -> IO (Response ByteString)

Session-specific version of getWith.

postWith :: Postable a => Options -> Session -> String -> a -> IO (Response ByteString)

Session-specific version of postWith.

headWith :: Options -> Session -> String -> IO (Response ())

Session-specific version of headWith.

optionsWith :: Options -> Session -> String -> IO (Response ())

Session-specific version of optionsWith.

putWith :: Putable a => Options -> Session -> String -> a -> IO (Response ByteString)

Session-specific version of putWith.

deleteWith :: Options -> Session -> String -> IO (Response ByteString)

Session-specific version of deleteWith.