Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x2b276322026-10-31Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 2b27632 · 2026-10-31

Modulecabal-install-3.18.1.0Haskell2010

Distribution.Client.HttpUtils

Separate module for HTTP actions, using a proxy server if one exists.

Synopsis

data DownloadResult
value configureTransport
data HttpTransport
type HttpCode
value downloadURI
value transportCheckHttps
value remoteRepoCheckHttps
value remoteRepoTryUpgradeToHttps
value isOldHackageURI

Packagecabal-install-3.18.1.0
Exports9
LanguageHaskell2010
LicenceBSD-3-Clause
SourceHttpUtils.hs

datadata DownloadResult

Constructors

FileAlreadyInCache
FileDownloaded FilePath

Instances1Eq

Eq DownloadResultDefined in cabal-install-3.18.1.0 · Distribution.Client.HttpUtils

valueconfigureTransport

datadata HttpTransport

Constructors

HttpTransport
- getHttp :: Verbosity -> URI -> Maybe ETag -> FilePath -> [Header] -> IO (HttpCode, Maybe ETag)
  GET a URI, with an optional ETag (to do a conditional fetch), write the resource to the given file and return the HTTP status code, and optional ETag.
- postHttp :: Verbosity -> URI -> String -> Maybe Auth -> IO (HttpCode, String)
  POST a resource to a URI, with optional Auth and return the HTTP status code and any redirect URL.
- postHttpFile :: Verbosity -> URI -> FilePath -> Maybe Auth -> IO (HttpCode, String)
  POST a file resource to a URI using multipart/form-data encoding, with optional Auth and return the HTTP status code and any error string.
- putHttpFile :: Verbosity -> URI -> FilePath -> Maybe Auth -> [Header] -> IO (HttpCode, String)
  PUT a file resource to a URI, with optional Auth, extra headers and return the HTTP status code and any error string.
- transportSupportsHttps :: Bool
  Whether this transport supports https or just http.
- transportManuallySelected :: Bool
  Whether this transport implementation was specifically chosen by the user via configuration, or whether it was automatically selected. Strictly speaking this is not a property of the transport itself but about how it was chosen. Nevertheless it's convenient to keep here.

typetype HttpCode = Int

valuedownloadURI

:: HttpTransport
-> Verbosity
-> URI
What to download
-> FilePath
Where to put it
-> IO DownloadResult

valuetransportCheckHttps :: Verbosity -> HttpTransport -> URI -> IO ()

If the URI scheme is HTTPS, ensure the transport supports HTTPS.

valueremoteRepoCheckHttps :: Verbosity -> HttpTransport -> RemoteRepo -> IO ()

If the remote repo is accessed over HTTPS, ensure that the transport supports HTTPS.

valueremoteRepoTryUpgradeToHttps

valueisOldHackageURI :: URI -> Bool

Utility function for legacy support.