@@ -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,72 +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)
223216import Control.Monad.Trans.Accum (AccumT)
224217import Control.Monad.Trans.Cont (ContT)
225218import Control.Monad.Trans.Control
226219import Control.Monad.Trans.Except (ExceptT)
227220import Control.Monad.Trans.Identity (IdentityT)
228221import Control.Monad.Trans.Maybe (MaybeT)
229−import qualified Control.Monad.Trans.RWS.CPS as RWS.CPS
230−import qualified Control.Monad.Trans.RWS.Lazy as RWS.Lazy
231−import qualified Control.Monad.Trans.RWS.Strict as RWS.Strict
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
232225import Control.Monad.Trans.Select (SelectT)
233−import qualified Control.Monad.Trans.State.Lazy as State.Lazy
234−import qualified Control.Monad.Trans.State.Strict as State.Strict
235−import qualified Control.Monad.Trans.Writer.CPS as Writer.CPS
236−import qualified Control.Monad.Trans.Writer.Lazy as Writer.Lazy
237−import qualified Control.Monad.Trans.Writer.Strict as Writer.Strict
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
238231import Control.Retry
239232import Data.Aeson (FromJSON (..), ToJSON (..))
240−import qualified Data.Aeson as A
233+import Data.Aeson qualified as A
241234import Data.ByteString (ByteString)
242−import qualified Data.ByteString as B
243−import qualified Data.ByteString.Lazy as BL
244−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
245238import Data.Data (Data)
239+import Data.Default.Class (def)
246240import Data.Function (on)
247241import Data.IORef
248242import Data.Kind (Constraint, Type)
249243import Data.List (foldl', nubBy)
250244import Data.List.NonEmpty (NonEmpty (..))
251−import qualified Data.List.NonEmpty as NE
245+import Data.List.NonEmpty qualified as NE
252246import Data.Maybe (fromMaybe)
253247import Data.Proxy
254−import Data.Semigroup hiding (Option, option)
248+import Data.Semigroup (Endo (..))
249+import Data.Set qualified as S
255250import Data.Text (Text)
256−import qualified Data.Text as T
257−import qualified Data.Text.Encoding as T
251+import Data.Text qualified as T
252+import Data.Text.Encoding qualified as T
258253import Data.Typeable (Typeable, cast)
259254import GHC.Generics
260255import GHC.TypeLits
261−import qualified Language.Haskell.TH as TH
262−import qualified Language.Haskell.TH.Quote as TH
263−import qualified Language.Haskell.TH.Syntax as TH
264−import qualified Network.Connection as NC
265−import qualified Network.HTTP.Client as L
266−import qualified Network.HTTP.Client.Internal as LI
267−import qualified Network.HTTP.Client.MultipartFormData as LM
268−import qualified Network.HTTP.Client.TLS as L
269−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
270265import System.IO.Unsafe (unsafePerformIO)
271266import Text.URI (URI)
272−import qualified Text.URI as URI
273−import qualified Text.URI.QQ as QQ
274−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
275272import Web.HttpApiData (ToHttpApiData (..))
276273
277274----------------------------------------------------------------------------
@@ -492,7 +489,7 @@ reqCb method url body responseProxy options adjustRequest =
492489--
493490-- @since 3.7.0
494491reqHandler ::
495− MonadHttp m =>
492+ (MonadHttp m) =>
496493 -- | How to get final result from a 'L.Response'
497494 (L.Response L.BodyReader -> IO b) ->
498495 -- | 'L.Request' to perform
@@ -588,10 +585,10 @@ req' method url body options m = do
588585 withReqManager (m request)
589586
590587-- | Perform an action using the global implicit 'L.Manager' that the rest
591−-- of the library uses. This allows to reuse connections that the
588+-- of the library uses. This allows us to reuse connections that the
592589-- 'L.Manager' controls.
593−withReqManager :: MonadIO m => (L.Manager -> m a) -> m a
594−withReqManager m = liftIO (readIORef globalManager) >>= m
590+withReqManager :: (MonadIO m) => (L.Manager -> m a) -> m a
591+withReqManager m = m globalManager
595592
596593-- | The global 'L.Manager' that 'req' uses. Here we just go with the
597594-- default settings, so users don't need to deal with this manager stuff at
@@ -604,16 +601,16 @@ withReqManager m = liftIO (readIORef globalManager) >>= m
604601-- manager. From that moment on the 'IORef' will be just reused—exactly the
605602-- behavior we want here in order to maximize connection sharing. GHC could
606603-- spoil the plan by inlining the definition, hence the @NOINLINE@ pragma.
607−globalManager :: IORef L.Manager
604+globalManager :: L.Manager
608605globalManager = unsafePerformIO $ do
609606 context <- NC.initConnectionContext
610607 let settings =
611608 L.mkManagerSettingsContext
612609 (Just context)
613− (NC.TLSSettingsSimple False False False)
610+ def
614611 Nothing
615612 manager <- L.newManager settings
616− newIORef manager
613+ return manager
617614{-# NOINLINE globalManager #-}
618615
619616----------------------------------------------------------------------------
@@ -633,7 +630,7 @@ globalManager = unsafePerformIO $ do
633630-- | A type class for monads that support performing HTTP requests.
634631-- Typically, you only need to define the 'handleHttpException' method
635632-- unless you want to tweak 'HttpConfig'.
636−class MonadIO m => MonadHttp m where
633+class (MonadIO m) => MonadHttp m where
637634 -- | This method describes how to deal with 'HttpException' that was
638635 -- caught by the library. One option is to re-throw it if you are OK with
639636 -- exceptions, but if you prefer working with something like
@@ -717,9 +714,8 @@ data HttpConfig = HttpConfig
717714 -- | Max length of preview fragment of response body.
718715 --
719716 -- @since 3.6.0
720− httpConfigBodyPreviewLength :: forall a. Num a => a
717+ httpConfigBodyPreviewLength :: forall a. (Num a) => a
721718 }
722− deriving (Typeable)
723719
724720-- | The default value of 'HttpConfig'.
725721--
@@ -807,27 +803,27 @@ instance (MonadHttp m, Monoid w) => MonadHttp (AccumT w m) where
807803 getHttpConfig = lift getHttpConfig
808804
809805-- | @since 3.10.0
810−instance MonadHttp m => MonadHttp (ContT r m) where
806+instance (MonadHttp m) => MonadHttp (ContT r m) where
811807 handleHttpException = lift . handleHttpException
812808 getHttpConfig = lift getHttpConfig
813809
814810-- | @since 3.10.0
815−instance MonadHttp m => MonadHttp (ExceptT e m) where
811+instance (MonadHttp m) => MonadHttp (ExceptT e m) where
816812 handleHttpException = lift . handleHttpException
817813 getHttpConfig = lift getHttpConfig
818814
819815-- | @since 3.10.0
820−instance MonadHttp m => MonadHttp (IdentityT m) where
816+instance (MonadHttp m) => MonadHttp (IdentityT m) where
821817 handleHttpException = lift . handleHttpException
822818 getHttpConfig = lift getHttpConfig
823819
824820-- | @since 3.10.0
825−instance MonadHttp m => MonadHttp (MaybeT m) where
821+instance (MonadHttp m) => MonadHttp (MaybeT m) where
826822 handleHttpException = lift . handleHttpException
827823 getHttpConfig = lift getHttpConfig
828824
829825-- | @since 3.10.0
830−instance MonadHttp m => MonadHttp (ReaderT r m) where
826+instance (MonadHttp m) => MonadHttp (ReaderT r m) where
831827 handleHttpException = lift . handleHttpException
832828 getHttpConfig = lift getHttpConfig
833829
@@ -847,17 +843,17 @@ instance (MonadHttp m, Monoid w) => MonadHttp (RWS.Strict.RWST r w s m) where
847843 getHttpConfig = lift getHttpConfig
848844
849845-- | @since 3.10.0
850−instance MonadHttp m => MonadHttp (SelectT r m) where
846+instance (MonadHttp m) => MonadHttp (SelectT r m) where
851847 handleHttpException = lift . handleHttpException
852848 getHttpConfig = lift getHttpConfig
853849
854850-- | @since 3.10.0
855−instance MonadHttp m => MonadHttp (State.Lazy.StateT s m) where
851+instance (MonadHttp m) => MonadHttp (State.Lazy.StateT s m) where
856852 handleHttpException = lift . handleHttpException
857853 getHttpConfig = lift getHttpConfig
858854
859855-- | @since 3.10.0
860−instance MonadHttp m => MonadHttp (State.Strict.StateT s m) where
856+instance (MonadHttp m) => MonadHttp (State.Strict.StateT s m) where
861857 handleHttpException = lift . handleHttpException
862858 getHttpConfig = lift getHttpConfig
863859
@@ -881,7 +877,7 @@ instance (MonadHttp m, Monoid w) => MonadHttp (Writer.Strict.WriterT w m) where
881877--
882878-- @since 0.4.0
883879runReq ::
884− MonadIO m =>
880+ (MonadIO m) =>
885881 -- | 'HttpConfig' to use
886882 HttpConfig ->
887883 -- | Computation to run
@@ -986,7 +982,7 @@ class HttpMethod a where
986982 -- | Return name of the method as a 'ByteString'.
987983 httpMethodName :: Proxy a -> ByteString
988984
989−instance HttpMethod method => RequestComponent (Tagged "method" method) where
985+instance (HttpMethod method) => RequestComponent (Tagged "method" method) where
990986 getRequestMod _ = Endo $ \x ->
991987 x {L.method = httpMethodName (Proxy :: Proxy method)}
992988
@@ -1028,25 +1024,20 @@ instance HttpMethod method => RequestComponent (Tagged "method" method) where
10281024-- > -- https://%D1%8E%D0%BD%D0%B8%D0%BA%D0%BE%D0%B4.%D1%80%D1%84
10291025data Url (scheme :: Scheme) = Url Scheme (NonEmpty Text)
10301026 -- NOTE The second value is the path segments in reversed order.
1031− deriving (Eq, Ord, Show, Data, Typeable, Generic)
1027+ deriving (Eq, Ord, Show, Data, Generic)
10321028
10331029type role Url nominal
10341030
10351031-- With template-haskell >=2.15 and text >=1.2.4 Lift can be derived, however
10361032-- the derived lift forgets the type of the scheme.
1037−instance Typeable scheme => TH.Lift (Url scheme) where
1033+instance (Typeable scheme) => TH.Lift (Url scheme) where
10381034 lift url =
10391035 TH.dataToExpQ (fmap liftText . cast) url `TH.sigE` case url of
10401036 Url Http _ -> [t|Url 'Http|]
10411037 Url Https _ -> [t|Url 'Https|]
10421038 where
10431039 liftText t = TH.AppE (TH.VarE 'T.pack) <$> TH.lift (T.unpack t)
1044−
1045−#if MIN_VERSION_template_haskell(2,17,0)
10461040 liftTyped = TH.Code . TH.unsafeTExpCoerce . TH.lift
1047−#elif MIN_VERSION_template_haskell(2,16,0)
1048− liftTyped = TH.unsafeTExpCoerce . TH.lift
1049−#endif
10501041
10511042-- | Given host name, produce a 'Url' which has “http” as its scheme and
10521043-- empty path. This also sets port to @80@.
@@ -1062,7 +1053,7 @@ https = Url Https . pure
10621053-- path segment can be of any type that is an instance of 'ToHttpApiData'.
10631054infixl 5 /~
10641055
1065−(/~) :: ToHttpApiData a => Url scheme -> a -> Url scheme
1056+(/~) :: (ToHttpApiData a) => Url scheme -> a -> Url scheme
10661057Url secure path /~ segment = Url secure (NE.cons (toUrlPiece segment) path)
10671058
10681059-- | A type-constrained version of @('/~')@ to remove ambiguity in the cases
@@ -1250,7 +1241,7 @@ instance HttpBody NoReqBody where
12501241-- charset=utf-8\"@ value.
12511242newtype ReqBodyJson a = ReqBodyJson a
12521243
1253−instance ToJSON a => HttpBody (ReqBodyJson a) where
1244+instance (ToJSON a) => HttpBody (ReqBodyJson a) where
12541245 getRequestBody (ReqBodyJson a) = L.RequestBodyLBS (A.encode a)
12551246 getRequestContentType _ = pure "application/json; charset=utf-8"
12561247
@@ -1303,6 +1294,13 @@ newtype FormUrlEncodedParam = FormUrlEncodedParam [(Text, Maybe Text)]
13031294instance QueryParam FormUrlEncodedParam where
13041295 queryParam name mvalue =
13051296 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
13061304
13071305-- | Multipart form data. Please consult the
13081306-- "Network.HTTP.Client.MultipartFormData" module for how to construct
@@ -1342,7 +1340,7 @@ instance HttpBody ReqBodyMultipart where
13421340-- | Create 'ReqBodyMultipart' request body from a collection of 'LM.Part's.
13431341--
13441342-- @since 0.2.0
1345−reqBodyMultipart :: MonadIO m => [LM.Part] -> m ReqBodyMultipart
1343+reqBodyMultipart :: (MonadIO m) => [LM.Part] -> m ReqBodyMultipart
13461344reqBodyMultipart parts = liftIO $ do
13471345 boundary <- LM.webkitBoundary
13481346 body <- LM.renderParts boundary parts
@@ -1382,7 +1380,7 @@ type family
13821380 TypeError
13831381 ('Text "This HTTP method does not allow attaching a request body.")
13841382
1385−instance HttpBody body => RequestComponent (Tagged "body" body) where
1383+instance (HttpBody body) => RequestComponent (Tagged "body" body) where
13861384 getRequestMod (Tagged body) = Endo $ \x ->
13871385 x
13881386 { L.requestBody = getRequestBody body,
@@ -1428,6 +1426,12 @@ instance Monoid (Option scheme) where
14281426 mempty = Option mempty Nothing
14291427 mappend = (<>)
14301428
1429+-- | Use 'formToQuery'.
1430+--
1431+-- @since 3.11.0
1432+instance FromForm (Option scheme) where
1433+ fromForm = Right . formToQuery
1434+
14311435-- | A helper to create an 'Option' that modifies only collection of query
14321436-- parameters. This helper is not a part of the public API.
14331437withQueryParams :: (Y.QueryText -> Y.QueryText) -> Option scheme
@@ -1446,7 +1450,7 @@ instance RequestComponent (Option scheme) where
14461450
14471451-- | Finalize given 'L.Request' by applying a finalizer from the given
14481452-- 'Option' (if it has any).
1449−finalizeRequest :: MonadIO m => Option scheme -> L.Request -> m L.Request
1453+finalizeRequest :: (MonadIO m) => Option scheme -> L.Request -> m L.Request
14501454finalizeRequest (Option _ mfinalizer) = liftIO . fromMaybe pure mfinalizer
14511455
14521456----------------------------------------------------------------------------
@@ -1479,9 +1483,27 @@ name =: value = queryParam name (pure value)
14791483-- This operator is defined in terms of 'queryParam':
14801484--
14811485-- > queryFlag name = queryParam name (Nothing :: Maybe ())
1482−queryFlag :: QueryParam param => Text -> param
1486+queryFlag :: (QueryParam param) => Text -> param
14831487queryFlag name = queryParam name (Nothing :: Maybe ())
14841488
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+
14851507-- | A type class for query-parameter-like things. The reason to have an
14861508-- overloaded 'queryParam' is to be able to use it as an 'Option' and as a
14871509-- 'FormUrlEncodedParam' when constructing form URL encoded request bodies.
@@ -1491,11 +1513,17 @@ class QueryParam param where
14911513 -- 'Nothing', it won't be included at all (i.e. you create a flag this
14921514 -- way). It's recommended to use @('=:')@ and 'queryFlag' instead of this
14931515 -- method, because they are easier to read.
1494− 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)]
14951522
14961523instance QueryParam (Option scheme) where
14971524 queryParam name mvalue =
14981525 withQueryParams ((:) (name, toQueryParam <$> mvalue))
1526+ queryParamToList (Option f _) = fst $ appEndo f ([], L.defaultRequest)
14991527
15001528----------------------------------------------------------------------------
15011529-- Request—Optional parameters—Headers
@@ -1519,6 +1547,14 @@ attachHeader :: ByteString -> ByteString -> L.Request -> L.Request
15191547attachHeader name value x =
15201548 x {L.requestHeaders = (CI.mk name, value) : L.requestHeaders x}
15211549
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+
15221558----------------------------------------------------------------------------
15231559-- Request—Optional parameters—Cookies
15241560
@@ -1726,7 +1762,7 @@ ignoreResponse = Proxy
17261762newtype JsonResponse a = JsonResponse (L.Response a)
17271763 deriving (Show)
17281764
1729−instance FromJSON a => HttpResponse (JsonResponse a) where
1765+instance (FromJSON a) => HttpResponse (JsonResponse a) where
17301766 type HttpResponseBody (JsonResponse a) = a
17311767 toVanillaResponse (JsonResponse r) = r
17321768 getHttpResponse r = do
@@ -1842,14 +1878,14 @@ brReadN br n = go 0 id id
18421878
18431879-- | Get the response body.
18441880responseBody ::
1845− HttpResponse response =>
1881+ (HttpResponse response) =>
18461882 response ->
18471883 HttpResponseBody response
18481884responseBody = L.responseBody . toVanillaResponse
18491885
18501886-- | Get the response status code.
18511887responseStatusCode ::
1852− HttpResponse response =>
1888+ (HttpResponse response) =>
18531889 response ->
18541890 Int
18551891responseStatusCode =
@@ -1857,7 +1893,7 @@ responseStatusCode =
18571893
18581894-- | Get the response status message.
18591895responseStatusMessage ::
1860− HttpResponse response =>
1896+ (HttpResponse response) =>
18611897 response ->
18621898 ByteString
18631899responseStatusMessage =
@@ -1865,7 +1901,7 @@ responseStatusMessage =
18651901
18661902-- | Lookup a particular header from a response.
18671903responseHeader ::
1868− HttpResponse response =>
1904+ (HttpResponse response) =>
18691905 -- | Response interpretation
18701906 response ->
18711907 -- | Header to lookup
@@ -1877,7 +1913,7 @@ responseHeader r h =
18771913
18781914-- | Get the response 'L.CookieJar'.
18791915responseCookieJar ::
1880− HttpResponse response =>
1916+ (HttpResponse response) =>
18811917 response ->
18821918 L.CookieJar
18831919responseCookieJar = L.responseCookieJar . toVanillaResponse
@@ -1931,6 +1967,16 @@ class HttpResponse response where
19311967 acceptHeader :: Proxy response -> Maybe ByteString
19321968 acceptHeader Proxy = Nothing
19331969
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+
19341980----------------------------------------------------------------------------
19351981-- Other
19361982
@@ -1965,10 +2011,24 @@ data HttpException
19652011 | -- | A wrapper with Aeson-produced 'String' describing why decoding
19662012 -- failed
19672013 JsonHttpException String
1968− deriving (Show, Typeable, Generic)
2014+ deriving (Show, Generic)
19692015
19702016instance Exception HttpException
19712017
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+
19722032-- | A simple type isomorphic to 'Bool' that we only have for better error
19732033-- messages. We use it as a kind and its data constructors as type-level
19742034-- tags.
@@ -1988,4 +2048,4 @@ data Scheme
19882048 Http
19892049 | -- | HTTPS
19902050 Https
1991− deriving (Eq, Ord, Show, Data, Typeable, Generic, TH.Lift)
2051+ deriving (Eq, Ord, Show, Data, Generic, TH.Lift)