@@ -1,20 +1,9 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
31{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE DeriveDataTypeable #-}
5−{-# LANGUAGE DeriveGeneric #-}
6−{-# LANGUAGE DeriveLift #-}
7−{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
92{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
113{-# LANGUAGE OverloadedStrings #-}
124{-# LANGUAGE QuasiQuotes #-}
13−{-# LANGUAGE RankNTypes #-}
145{-# LANGUAGE RecordWildCards #-}
156{-# LANGUAGE RoleAnnotations #-}
16−{-# LANGUAGE ScopedTypeVariables #-}
17−{-# LANGUAGE StandaloneDeriving #-}
187{-# LANGUAGE TemplateHaskellQuotes #-}
198{-# LANGUAGE TypeFamilies #-}
209{-# LANGUAGE UndecidableInstances #-}
@@ -155,11 +144,13 @@ module Network.HTTP.Req
155144 -- $query-parameters
156145 (=:),
157146 queryFlag,
147+ formToQuery,
158148 QueryParam (..),
159149
160150 -- *** Headers
161151 header,
162152 attachHeader,
153+ headerRedacted,
163154
164155 -- *** Cookies
165156 -- $cookies
@@ -206,58 +197,78 @@ module Network.HTTP.Req
206197
207198 -- * Other
208199 HttpException (..),
200+ isStatusCodeException,
209201 CanHaveBody (..),
210202 Scheme (..),
211203 )
212204where
213205
214−import qualified Blaze.ByteString.Builder as BB
206+import Blaze.ByteString.Builder qualified as BB
215207import Control.Applicative
216208import Control.Arrow (first, second)
217209import Control.Exception hiding (Handler (..), TypeError)
210+import Control.Monad (guard, void, (>=>))
218211import Control.Monad.Base
219212import Control.Monad.Catch (Handler (..), MonadCatch, MonadMask, MonadThrow)
220213import Control.Monad.IO.Class
221214import Control.Monad.IO.Unlift
222−import Control.Monad.Reader
215+import Control.Monad.Reader (ReaderT (ReaderT), ask, lift, runReaderT)
216+import Control.Monad.Trans.Accum (AccumT)
217+import Control.Monad.Trans.Cont (ContT)
223218import Control.Monad.Trans.Control
219+import Control.Monad.Trans.Except (ExceptT)
220+import Control.Monad.Trans.Identity (IdentityT)
221+import Control.Monad.Trans.Maybe (MaybeT)
222+import Control.Monad.Trans.RWS.CPS qualified as RWS.CPS
223+import Control.Monad.Trans.RWS.Lazy qualified as RWS.Lazy
224+import Control.Monad.Trans.RWS.Strict qualified as RWS.Strict
225+import Control.Monad.Trans.Select (SelectT)
226+import Control.Monad.Trans.State.Lazy qualified as State.Lazy
227+import Control.Monad.Trans.State.Strict qualified as State.Strict
228+import Control.Monad.Trans.Writer.CPS qualified as Writer.CPS
229+import Control.Monad.Trans.Writer.Lazy qualified as Writer.Lazy
230+import Control.Monad.Trans.Writer.Strict qualified as Writer.Strict
224231import Control.Retry
225232import Data.Aeson (FromJSON (..), ToJSON (..))
226−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
227234import Data.ByteString (ByteString)
228−import qualified Data.ByteString as B
229−import qualified Data.ByteString.Lazy as BL
230−import qualified Data.CaseInsensitive as CI
235+import Data.ByteString qualified as B
236+import Data.ByteString.Lazy qualified as BL
237+import Data.CaseInsensitive qualified as CI
231238import Data.Data (Data)
239+import Data.Default.Class (def)
232240import Data.Function (on)
233241import Data.IORef
234242import Data.Kind (Constraint, Type)
235243import Data.List (foldl', nubBy)
236244import Data.List.NonEmpty (NonEmpty (..))
237−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
238246import Data.Maybe (fromMaybe)
239247import Data.Proxy
240−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
241250import Data.Text (Text)
242−import qualified Data.Text as T
243−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
244253import Data.Typeable (Typeable, cast)
245254import GHC.Generics
246255import GHC.TypeLits
247−import qualified Language.Haskell.TH as TH
248−import qualified Language.Haskell.TH.Quote as TH
249−import qualified Language.Haskell.TH.Syntax as TH
250−import qualified Network.Connection as NC
251−import qualified Network.HTTP.Client as L
252−import qualified Network.HTTP.Client.Internal as LI
253−import qualified Network.HTTP.Client.MultipartFormData as LM
254−import qualified Network.HTTP.Client.TLS as L
255−import qualified Network.HTTP.Types as Y
256+import Language.Haskell.TH qualified as TH
257+import Language.Haskell.TH.Quote qualified as TH
258+import Language.Haskell.TH.Syntax qualified as TH
259+import Network.Connection qualified as NC
260+import Network.HTTP.Client qualified as L
261+import Network.HTTP.Client.Internal qualified as LI
262+import Network.HTTP.Client.MultipartFormData qualified as LM
263+import Network.HTTP.Client.TLS qualified as L
264+import Network.HTTP.Types qualified as Y
256265import System.IO.Unsafe (unsafePerformIO)
257266import Text.URI (URI)
258−import qualified Text.URI as URI
259−import qualified Text.URI.QQ as QQ
260−import qualified Web.Authenticate.OAuth as OAuth
267+import Text.URI qualified as URI
268+import Text.URI.QQ qualified as QQ
269+import Web.Authenticate.OAuth qualified as OAuth
270+import Web.FormUrlEncoded (FromForm (..), ToForm (..))
271+import Web.FormUrlEncoded qualified as Form
261272import Web.HttpApiData (ToHttpApiData (..))
262273
263274----------------------------------------------------------------------------
@@ -478,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
478489--
479490-- @since 3.7.0
480491reqHandler ::
481− MonadHttp m =>
492+ (MonadHttp m) =>
482493 -- | How to get final result from a 'L.Response'
483494 (L.Response L.BodyReader -> IO b) ->
484495 -- | 'L.Request' to perform
@@ -574,10 +585,10 @@ req' method url body options m = do
574585 withReqManager (m request)
575586
576587-- | Perform an action using the global implicit 'L.Manager' that the rest
577−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
578589-- 'L.Manager' controls.
579−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
580−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
581592
582593-- | The global 'L.Manager' that 'req' uses. Here we just go with the
583594-- default settings, so users don't need to deal with this manager stuff at
@@ -590,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
590601-- manager. From that moment on the 'IORef' will be just reused—exactly the
591602-- behavior we want here in order to maximize connection sharing. GHC could
592603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
593−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
594605globalManager = unsafePerformIO $ do
595606 context <- NC.initConnectionContext
596607 let settings =
597608 L.mkManagerSettingsContext
598609 (Just context)
599− (NC.TLSSettingsSimple False False False)
610+ def
600611 Nothing
601612 manager <- L.newManager settings
602− newIORef manager
613+ return manager
603614{-# NOINLINE globalManager #-}
604615
605616----------------------------------------------------------------------------
@@ -619,7 +630,7 @@ globalManager = unsafePerformIO $ do
619630-- | A type class for monads that support performing HTTP requests.
620631-- Typically, you only need to define the 'handleHttpException' method
621632-- unless you want to tweak 'HttpConfig'.
622−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
623634 -- | This method describes how to deal with 'HttpException' that was
624635 -- caught by the library. One option is to re-throw it if you are OK with
625636 -- exceptions, but if you prefer working with something like
@@ -680,8 +691,8 @@ data HttpConfig = HttpConfig
680691 -- | The retry policy to use for request retrying. By default 'def' is
681692 -- used (see 'RetryPolicyM').
682693 --
683− -- __Note__: signature of this function was changed in the version
684− -- /1.0.0/.
694+ -- __Note__: signature of this function was changed to disallow 'IO' in
695+ -- version /1.0.0/ and then changed back to its current form in /3.1.0/.
685696 --
686697 -- @since 0.3.0
687698 httpConfigRetryPolicy :: RetryPolicyM IO,
@@ -703,9 +714,8 @@ data HttpConfig = HttpConfig
703714 -- | Max length of preview fragment of response body.
704715 --
705716 -- @since 3.6.0
706− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
707718 }
708− deriving (Typeable)
709719
710720-- | The default value of 'HttpConfig'.
711721--
@@ -787,12 +797,87 @@ instance MonadHttp Req where
787797 handleHttpException = Req . lift . throwIO
788798 getHttpConfig = Req ask
789799
800+-- | @since 3.10.0
801+instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
802+ handleHttpException = lift . handleHttpException
803+ getHttpConfig = lift getHttpConfig
804+
805+-- | @since 3.10.0
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
807+ handleHttpException = lift . handleHttpException
808+ getHttpConfig = lift getHttpConfig
809+
810+-- | @since 3.10.0
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
812+ handleHttpException = lift . handleHttpException
813+ getHttpConfig = lift getHttpConfig
814+
815+-- | @since 3.10.0
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
817+ handleHttpException = lift . handleHttpException
818+ getHttpConfig = lift getHttpConfig
819+
820+-- | @since 3.10.0
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
822+ handleHttpException = lift . handleHttpException
823+ getHttpConfig = lift getHttpConfig
824+
825+-- | @since 3.10.0
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
827+ handleHttpException = lift . handleHttpException
828+ getHttpConfig = lift getHttpConfig
829+
830+-- | @since 3.10.0
831+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.CPS.RWST r w s m) where
832+ handleHttpException = lift . handleHttpException
833+ getHttpConfig = lift getHttpConfig
834+
835+-- | @since 3.10.0
836+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Lazy.RWST r w s m) where
837+ handleHttpException = lift . handleHttpException
838+ getHttpConfig = lift getHttpConfig
839+
840+-- | @since 3.10.0
841+instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
842+ handleHttpException = lift . handleHttpException
843+ getHttpConfig = lift getHttpConfig
844+
845+-- | @since 3.10.0
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
847+ handleHttpException = lift . handleHttpException
848+ getHttpConfig = lift getHttpConfig
849+
850+-- | @since 3.10.0
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
852+ handleHttpException = lift . handleHttpException
853+ getHttpConfig = lift getHttpConfig
854+
855+-- | @since 3.10.0
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
857+ handleHttpException = lift . handleHttpException
858+ getHttpConfig = lift getHttpConfig
859+
860+-- | @since 3.10.0
861+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.CPS.WriterT w m) where
862+ handleHttpException = lift . handleHttpException
863+ getHttpConfig = lift getHttpConfig
864+
865+-- | @since 3.10.0
866+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Lazy.WriterT w m) where
867+ handleHttpException = lift . handleHttpException
868+ getHttpConfig = lift getHttpConfig
869+
870+-- | @since 3.10.0
871+instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
872+ handleHttpException = lift . handleHttpException
873+ getHttpConfig = lift getHttpConfig
874+
790875-- | Run a computation in the 'Req' monad with the given 'HttpConfig'. In
791876-- the case of an exceptional situation an 'HttpException' will be thrown.
792877--
793878-- @since 0.4.0
794879runReq ::
795− MonadIO m =>
880+ (MonadIO m) =>
796881 -- | 'HttpConfig' to use
797882 HttpConfig ->
798883 -- | Computation to run
@@ -897,7 +982,7 @@ class HttpMethod a where
897982 -- | Return name of the method as a 'ByteString'.
898983 httpMethodName :: Proxy a -> ByteString
899984
900−instance HttpMethod method => RequestComponent (Tagged "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
901986 getRequestMod _ = Endo $ \x ->
902987 x {L.method = httpMethodName (Proxy :: Proxy method)}
903988
@@ -939,23 +1024,20 @@ instance HttpMethod method => RequestComponent (Tagged "method" method) where
9391024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
9401025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
9411026 -- NOTE The second value is the path segments in reversed order.
942− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
9431028
9441029type role Url nominal
9451030
9461031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
9471032-- the derived lift forgets the type of the scheme.
948−instance Typeable scheme => TH.Lift (Url scheme) where
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
9491034 lift url =
9501035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
9511036 Url Http _ -> [t|Url 'Http|]
9521037 Url Https _ -> [t|Url 'Https|]
9531038 where
9541039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
955−
956−#if MIN_VERSION_template_haskell(2,16,0)
957− liftTyped url = TH.TExp <$> TH.lift url
958−#endif
1040+ liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
9591041
9601042-- | Given host name, produce a 'Url' which has “http” as its scheme and
9611043-- empty path. This also sets port to @80@.
@@ -971,7 +1053,7 @@ https = Url Https . pure
9711053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
9721054infixl 5 /~
9731055
974−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
9751057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
9761058
9771059-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
@@ -1159,7 +1241,7 @@ instance HttpBody NoReqBody where
11591241-- charset=utf-8\"@ value.
11601242newtype ReqBodyJson a = ReqBodyJson a
11611243
1162−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
11631245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
11641246 getRequestContentType _ = pure "application/json; charset=utf-8"
11651247
@@ -1212,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
12121294instance QueryParam FormUrlEncodedParam where
12131295 queryParam name mvalue =
12141296 FormUrlEncodedParam [(name, toQueryParam <$> mvalue)]
1297+ queryParamToList (FormUrlEncodedParam p) = p
1298+
1299+-- | Use 'formToQuery'.
1300+--
1301+-- @since 3.11.0
1302+instance FromForm FormUrlEncodedParam where
1303+ fromForm = Right . formToQuery
12151304
12161305-- | Multipart form data. Please consult the
12171306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1251,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
12511340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
12521341--
12531342-- @since 0.2.0
1254−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
12551344reqBodyMultipart parts = liftIO $ do
12561345 boundary <- LM.webkitBoundary
12571346 body <- LM.renderParts boundary parts
@@ -1291,7 +1380,7 @@ type family
12911380 TypeError
12921381 ('Text "This HTTP method does not allow attaching a request body.")
12931382
1294−instance HttpBody body => RequestComponent (Tagged "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
12951384 getRequestMod (Tagged body) = Endo $ \x ->
12961385 x
12971386 { L.requestBody = getRequestBody body,
@@ -1337,6 +1426,12 @@ instance Monoid (Option scheme) where
13371426 mempty = Option mempty Nothing
13381427 mappend = (<>)
13391428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
13401435-- | A helper to create an 'Option' that modifies only collection of query
13411436-- parameters. This helper is not a part of the public API.
13421437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1355,7 +1450,7 @@ instance RequestComponent (Option scheme) where
13551450
13561451-- | Finalize given 'L.Request' by applying a finalizer from the given
13571452-- 'Option' (if it has any).
1358−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
13591454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
13601455
13611456----------------------------------------------------------------------------
@@ -1388,9 +1483,27 @@ name =: value = queryParam name (pure value)
13881483-- This operator is defined in terms of 'queryParam':
13891484--
13901485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1391−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
13921487queryFlag name = queryParam name (Nothing :: Maybe ())
13931488
1489+-- | Construct query parameters from a 'ToForm' instance. This function
1490+-- produces the same query params as 'Form.urlEncodeAsFormStable'.
1491+--
1492+-- Note that 'Form.Form' doesn't have the concept of parameters with the
1493+-- empty value (i.e. what you can get by @key =: ""@). If the value is
1494+-- empty, it will be encoded as a valueless parameter (i.e. what you can get
1495+-- by @queryFlag key@).
1496+--
1497+-- @since 3.11.0
1498+formToQuery :: (QueryParam param, Monoid param, ToForm f) => f -> param
1499+formToQuery f = mconcat . fmap toParam . Form.toListStable $ toForm f
1500+ where
1501+ toParam (key, val) =
1502+ queryParam key $
1503+ if val == ""
1504+ then Nothing
1505+ else Just val
1506+
13941507-- | A type class for query-parameter-like things. The reason to have an
13951508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
13961509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1400,11 +1513,17 @@ class QueryParam param where
14001513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
14011514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
14021515 -- method, because they are easier to read.
1403− queryParam :: ToHttpApiData a => Text -> Maybe a -> param
1516+ queryParam :: (ToHttpApiData a) => Text -> Maybe a -> param
1517+
1518+ -- | Get the query parameter names and values set by 'queryParam'.
1519+ --
1520+ -- @since 3.11.0
1521+ queryParamToList :: param -> [(Text, Maybe Text)]
14041522
14051523instance QueryParam (Option scheme) where
14061524 queryParam name mvalue =
14071525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
14081527
14091528----------------------------------------------------------------------------
14101529-- Request—Optional parameters—Headers
@@ -1428,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
14281547attachHeader name value x =
14291548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
14301549
1550+-- | Same as 'header', but with redacted values on print.
1551+--
1552+-- @since 3.13.0
1553+headerRedacted :: ByteString -> ByteString -> Option scheme
1554+headerRedacted name value = withRequest $ \x ->
1555+ let y = attachHeader name value x
1556+ in y {L.redactHeaders = CI.mk name `S.insert` L.redactHeaders y}
1557+
14311558----------------------------------------------------------------------------
14321559-- Request—Optional parameters—Cookies
14331560
@@ -1635,7 +1762,7 @@ ignoreResponse = Proxy
16351762newtype JsonResponse a = JsonResponse (L.Response a)
16361763 deriving (Show)
16371764
1638−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
16391766 type HttpResponseBody (JsonResponse a) = a
16401767 toVanillaResponse (JsonResponse r) = r
16411768 getHttpResponse r = do
@@ -1751,14 +1878,14 @@ brReadN br n = go 0 id id
17511878
17521879-- | Get the response body.
17531880responseBody ::
1754− HttpResponse response =>
1881+ (HttpResponse response) =>
17551882 response ->
17561883 HttpResponseBody response
17571884responseBody = L.responseBody . toVanillaResponse
17581885
17591886-- | Get the response status code.
17601887responseStatusCode ::
1761− HttpResponse response =>
1888+ (HttpResponse response) =>
17621889 response ->
17631890 Int
17641891responseStatusCode =
@@ -1766,7 +1893,7 @@ responseStatusCode =
17661893
17671894-- | Get the response status message.
17681895responseStatusMessage ::
1769− HttpResponse response =>
1896+ (HttpResponse response) =>
17701897 response ->
17711898 ByteString
17721899responseStatusMessage =
@@ -1774,7 +1901,7 @@ responseStatusMessage =
17741901
17751902-- | Lookup a particular header from a response.
17761903responseHeader ::
1777− HttpResponse response =>
1904+ (HttpResponse response) =>
17781905 -- | Response interpretation
17791906 response ->
17801907 -- | Header to lookup
@@ -1786,7 +1913,7 @@ responseHeader r h =
17861913
17871914-- | Get the response 'L.CookieJar'.
17881915responseCookieJar ::
1789− HttpResponse response =>
1916+ (HttpResponse response) =>
17901917 response ->
17911918 L.CookieJar
17921919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1840,6 +1967,16 @@ class HttpResponse response where
18401967 acceptHeader :: Proxy response -> Maybe ByteString
18411968 acceptHeader Proxy = Nothing
18421969
1970+-- | This instance has been added to make it easier to inspect 'L.Response'
1971+-- using Req's functions like 'responseStatusCode', 'responseStatusMessage',
1972+-- etc.
1973+--
1974+-- @since 3.12.0
1975+instance HttpResponse (L.Response ()) where
1976+ type HttpResponseBody (L.Response ()) = ()
1977+ toVanillaResponse = id
1978+ getHttpResponse = return . void
1979+
18431980----------------------------------------------------------------------------
18441981-- Other
18451982
@@ -1874,10 +2011,24 @@ data HttpException
18742011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
18752012 -- failed
18762013 JsonHttpException String
1877− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
18782015
18792016instance Exception HttpException
18802017
2018+-- | Return 'Just' if the given 'HttpException' is wrapping a http-client's
2019+-- 'L.StatusCodeException'. Otherwise, return 'Nothing'.
2020+--
2021+-- @since 3.12.0
2022+isStatusCodeException :: HttpException -> Maybe (L.Response ())
2023+isStatusCodeException
2024+ ( VanillaHttpException
2025+ ( L.HttpExceptionRequest
2026+ _
2027+ (L.StatusCodeException r _)
2028+ )
2029+ ) = Just r
2030+isStatusCodeException _ = Nothing
2031+
18812032-- | A simple type isomorphic to 'Bool' that we only have for better error
18822033-- messages. We use it as a kind and its data constructors as type-level
18832034-- tags.
@@ -1897,4 +2048,4 @@ data Scheme
18972048 Http
18982049 | -- | HTTPS
18992050 Https
1900− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)