Network.HTTP.Client.Overrides

HTTP client overrides

withHttpClientOverrides :: HasCallStack => ManagerSettings -> IO (Either ParseException ManagerSettings)

If the HTTP_CLIENT_OVERRIDES environment variable is set, this function reads the specified file as a ConfigFile and applies the overrides to ManagerSettings.

withHttpClientOverridesThrow :: HasCallStack => ManagerSettings -> IO ManagerSettings

If the HTTP_CLIENT_OVERRIDES environment variable is set, this function reads the specified file as a ConfigFile and applies the overrides to ManagerSettings. Throws an exception if the config file can't be parsed.

withHttpClientOverridesFile :: ConfigFile -> ManagerSettings -> ManagerSettings

Applies the overrides from a ConfigFile to ManagerSettings.

httpClientOverrides :: Config -> ManagerSettings -> ManagerSettings

Overrides ManagerSettings using an HTTP client override Config. Use this function if you want to define overrides directly in your source code rather than from a config file.

parseConfigFile :: FilePath -> IO (Either ParseException ConfigFile)

Parses a file as a ConfigFile. Use this function if you need control over how the config file is loaded.

Types

data ConfigFile

The configuration file is versioned so that it can be changed in the future and the old format gradually deprecated. The parsers uses the version field to decide how to parse the file.

Constructors

V1 Config

Instances

Eq ConfigFile

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

(==) :: ConfigFile -> ConfigFile -> Bool

(/=) :: ConfigFile -> ConfigFile -> Bool

Show ConfigFile

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

showsPrec :: Int -> ConfigFile -> ShowS

show :: ConfigFile -> String

showList :: [ConfigFile] -> ShowS

Generic ConfigFile

Defined in Network.HTTP.Client.Overrides.Internal.Types

Associated Types

type Rep ConfigFile :: Type -> Type

Methods

from :: ConfigFile -> Rep ConfigFile x

to :: Rep ConfigFile x -> ConfigFile

FromJSON ConfigFile

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

parseJSON :: Value -> Parser ConfigFile

parseJSONList :: Value -> Parser [ConfigFile]

type Rep ConfigFile

Defined in Network.HTTP.Client.Overrides.Internal.Types

type Rep ConfigFile = D1 (MetaData "ConfigFile" "Network.HTTP.Client.Overrides.Internal.Types" "http-client-overrides-0.1.1.0-1ADWa4mmzAO6LjqUP7rpo" False) (C1 (MetaCons "V1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Config)))

data Config

This type is used when the ConfigFile version is v1.

Constructors

Config

Fields

• logOptions :: !LogOptions

  Options for logging HTTP requests and responses

• requestOverrides :: ![RequestOverride]

  Overrides to apply to HTTP requests

Instances

Eq Config

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

Show Config

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

Generic Config

Defined in Network.HTTP.Client.Overrides.Internal.Types

Associated Types

type Rep Config :: Type -> Type

Methods

from :: Config -> Rep Config x

to :: Rep Config x -> Config

FromJSON Config

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

type Rep Config

Defined in Network.HTTP.Client.Overrides.Internal.Types

type Rep Config = D1 (MetaData "Config" "Network.HTTP.Client.Overrides.Internal.Types" "http-client-overrides-0.1.1.0-1ADWa4mmzAO6LjqUP7rpo" False) (C1 (MetaCons "Config" PrefixI True) (S1 (MetaSel (Just "logOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LogOptions) :*: S1 (MetaSel (Just "requestOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [RequestOverride])))

data LogOptions

Constructors

LogOptions

Fields

• logResponses :: !(Maybe LogFormat)

  Log HTTP responses

• logRequests :: !(Maybe LogFormat)

  Log HTTP requests

• logRequestOverrides :: !(Maybe LogFormat)

  Log any overridden HTTP requests

Instances

Eq LogOptions

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

(==) :: LogOptions -> LogOptions -> Bool

(/=) :: LogOptions -> LogOptions -> Bool

Show LogOptions

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

showsPrec :: Int -> LogOptions -> ShowS

show :: LogOptions -> String

showList :: [LogOptions] -> ShowS

Generic LogOptions

Defined in Network.HTTP.Client.Overrides.Internal.Types

Associated Types

type Rep LogOptions :: Type -> Type

Methods

from :: LogOptions -> Rep LogOptions x

to :: Rep LogOptions x -> LogOptions

FromJSON LogOptions

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

parseJSON :: Value -> Parser LogOptions

parseJSONList :: Value -> Parser [LogOptions]

type Rep LogOptions

Defined in Network.HTTP.Client.Overrides.Internal.Types

type Rep LogOptions = D1 (MetaData "LogOptions" "Network.HTTP.Client.Overrides.Internal.Types" "http-client-overrides-0.1.1.0-1ADWa4mmzAO6LjqUP7rpo" False) (C1 (MetaCons "LogOptions" PrefixI True) (S1 (MetaSel (Just "logResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LogFormat)) :*: (S1 (MetaSel (Just "logRequests") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LogFormat)) :*: S1 (MetaSel (Just "logRequestOverrides") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LogFormat)))))

data LogFormat

Constructors

Simple

Simple log format (single-line)

Detailed

Detailed log format

Instances

Eq LogFormat

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

(==) :: LogFormat -> LogFormat -> Bool

(/=) :: LogFormat -> LogFormat -> Bool

Show LogFormat

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

showsPrec :: Int -> LogFormat -> ShowS

show :: LogFormat -> String

showList :: [LogFormat] -> ShowS

Generic LogFormat

Defined in Network.HTTP.Client.Overrides.Internal.Types

Associated Types

type Rep LogFormat :: Type -> Type

Methods

from :: LogFormat -> Rep LogFormat x

to :: Rep LogFormat x -> LogFormat

FromJSON LogFormat

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

parseJSON :: Value -> Parser LogFormat

parseJSONList :: Value -> Parser [LogFormat]

type Rep LogFormat

Defined in Network.HTTP.Client.Overrides.Internal.Types

type Rep LogFormat = D1 (MetaData "LogFormat" "Network.HTTP.Client.Overrides.Internal.Types" "http-client-overrides-0.1.1.0-1ADWa4mmzAO6LjqUP7rpo" False) (C1 (MetaCons "Simple" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Detailed" PrefixI False) (U1 :: Type -> Type))

data RequestOverride

Constructors

RequestOverride

Fields

• match :: !URL

  Match HTTP requests according to this URL

• override :: !URL

  Override HTTP reuests using this URL

Instances

Eq RequestOverride

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

(==) :: RequestOverride -> RequestOverride -> Bool

(/=) :: RequestOverride -> RequestOverride -> Bool

Show RequestOverride

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

showsPrec :: Int -> RequestOverride -> ShowS

show :: RequestOverride -> String

showList :: [RequestOverride] -> ShowS

Generic RequestOverride

Defined in Network.HTTP.Client.Overrides.Internal.Types

Associated Types

type Rep RequestOverride :: Type -> Type

Methods

from :: RequestOverride -> Rep RequestOverride x

to :: Rep RequestOverride x -> RequestOverride

FromJSON RequestOverride

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

parseJSON :: Value -> Parser RequestOverride

parseJSONList :: Value -> Parser [RequestOverride]

type Rep RequestOverride

Defined in Network.HTTP.Client.Overrides.Internal.Types

type Rep RequestOverride = D1 (MetaData "RequestOverride" "Network.HTTP.Client.Overrides.Internal.Types" "http-client-overrides-0.1.1.0-1ADWa4mmzAO6LjqUP7rpo" False) (C1 (MetaCons "RequestOverride" PrefixI True) (S1 (MetaSel (Just "match") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 URL) :*: S1 (MetaSel (Just "override") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 URL)))

data URL

Constructors

URL

Fields

• secure :: !(Maybe Bool)
• host :: !(Maybe ByteString)
• port :: !(Maybe Int)
• path :: !(Maybe ByteString)

Instances

Eq URL

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

(==) :: URL -> URL -> Bool

(/=) :: URL -> URL -> Bool

Show URL

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

Generic URL

Defined in Network.HTTP.Client.Overrides.Internal.Types

Associated Types

type Rep URL :: Type -> Type

Methods

from :: URL -> Rep URL x

to :: Rep URL x -> URL

FromJSON URL

Defined in Network.HTTP.Client.Overrides.Internal.Types

Methods

parseJSON :: Value -> Parser URL

parseJSONList :: Value -> Parser [URL]

type Rep URL

Defined in Network.HTTP.Client.Overrides.Internal.Types

type Rep URL = D1 (MetaData "URL" "Network.HTTP.Client.Overrides.Internal.Types" "http-client-overrides-0.1.1.0-1ADWa4mmzAO6LjqUP7rpo" False) (C1 (MetaCons "URL" PrefixI True) ((S1 (MetaSel (Just "secure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "host") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString))) :*: (S1 (MetaSel (Just "port") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :*: S1 (MetaSel (Just "path") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString)))))