| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.HTTP.Download
- verifiedDownload :: (MonadReader env m, HasHttpManager env, MonadIO m, MonadLogger m) => DownloadRequest -> Path Abs File -> (Maybe Integer -> Sink ByteString (ReaderT env IO) ()) -> m Bool
- data DownloadRequest = DownloadRequest {
- drRequest :: Request
- drHashChecks :: [HashCheck]
- drLengthCheck :: Maybe LengthCheck
- drRetryPolicy :: RetryPolicy
- drRetryPolicyDefault :: RetryPolicy
- data HashCheck = (Show a, HashAlgorithm a) => HashCheck {}
- data DownloadException
- = DownloadJSONException Request String
- | RedownloadFailed Request (Path Abs File) (Response ())
- data CheckHexDigest
- type LengthCheck = Int
- data VerifiedDownloadException
- = WrongContentLength Request Int ByteString
- | WrongStreamLength Request Int Int
- | WrongDigest Request String CheckHexDigest String
- download :: (MonadReader env m, HasHttpManager env, MonadIO m, MonadLogger m) => Request -> Path Abs File -> m Bool
- redownload :: (MonadReader env m, HasHttpManager env, MonadIO m, MonadLogger m) => Request -> Path Abs File -> m Bool
- downloadJSON :: (FromJSON a, MonadReader env m, HasHttpManager env, MonadIO m, MonadMask m) => Request -> m a
- parseUrl :: MonadThrow m => String -> m Request
- liftHTTP :: (MonadIO m, MonadReader env m, HasHttpManager env) => ReaderT Manager IO a -> m a
- ask :: MonadReader r m => m r
- getHttpManager :: HasHttpManager a => a -> Manager
- class Monad m => MonadReader r m | m -> r where
- ask :: m r
- class HasHttpManager a where
- getHttpManager :: a -> Manager
Documentation
Arguments
| :: (MonadReader env m, HasHttpManager env, MonadIO m, MonadLogger m) | |
| => DownloadRequest | |
| -> Path Abs File | destination |
| -> (Maybe Integer -> Sink ByteString (ReaderT env IO) ()) | custom hook to observe progress |
| -> m Bool | Whether a download was performed |
Copied and extended version of Network.HTTP.Download.download.
Has the following additional features: * Verifies that response content-length header (if present) matches expected length * Limits the download to (close to) the expected # of bytes * Verifies that the expected # bytes were downloaded (not too few) * Verifies md5 if response includes content-md5 header * Verifies the expected hashes
Throws VerifiedDownloadException. Throws IOExceptions related to file system operations. Throws HttpException.
data DownloadRequest #
A request together with some checks to perform.
Constructors
| DownloadRequest | |
Fields
| |
drRetryPolicyDefault :: RetryPolicy #
Default to retrying thrice with a short constant delay.
data DownloadException #
Constructors
| DownloadJSONException Request String | |
| RedownloadFailed Request (Path Abs File) (Response ()) |
Instances
data CheckHexDigest #
Constructors
| CheckHexDigestString String | |
| CheckHexDigestByteString ByteString | |
| CheckHexDigestHeader ByteString |
Instances
type LengthCheck = Int #
data VerifiedDownloadException #
An exception regarding verification of a download.
Constructors
| WrongContentLength Request Int ByteString | |
| WrongStreamLength Request Int Int | |
| WrongDigest Request String CheckHexDigest String |
Arguments
| :: (MonadReader env m, HasHttpManager env, MonadIO m, MonadLogger m) | |
| => Request | |
| -> Path Abs File | destination |
| -> m Bool | Was a downloaded performed (True) or did the file already exist (False)? |
Download the given URL to the given location. If the file already exists, no download is performed. Otherwise, creates the parent directory, downloads to a temporary file, and on file download completion moves to the appropriate destination.
Throws an exception if things go wrong
Arguments
| :: (MonadReader env m, HasHttpManager env, MonadIO m, MonadLogger m) | |
| => Request | |
| -> Path Abs File | destination |
| -> m Bool |
downloadJSON :: (FromJSON a, MonadReader env m, HasHttpManager env, MonadIO m, MonadMask m) => Request -> m a #
Download a JSON value and parse it using a FromJSON instance.
liftHTTP :: (MonadIO m, MonadReader env m, HasHttpManager env) => ReaderT Manager IO a -> m a #
A convenience method for asking for the environment and then running an
action with its Manager. Useful for avoiding a MonadBaseControl
constraint.
ask :: MonadReader r m => m r #
Retrieves the monad environment.
getHttpManager :: HasHttpManager a => a -> Manager #
class Monad m => MonadReader r m | m -> r where #
See examples in Control.Monad.Reader.
Note, the partially applied function type (->) r is a simple reader monad.
See the instance declaration below.
Instances
class HasHttpManager a where #
Instances
| HasHttpManager Manager | |
| HasHttpManager MiniConfig # | |
| HasHttpManager (Env config) # | |