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 {}
- drRetryPolicyDefault :: RetryPolicy
- data HashCheck = (Show a, HashAlgorithm a) => HashCheck {}
- data DownloadException
- data CheckHexDigest
- type LengthCheck = Int
- data VerifiedDownloadException
- 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
- parseRequest :: MonadThrow m => String -> m Request
- parseUrlThrow :: 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.
Constructors
(Show a, HashAlgorithm a) => HashCheck | |
Fields |
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.
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.
parseRequest :: MonadThrow m => String -> m Request #
Convert a URL into a Request
.
This defaults some of the values in Request
, such as setting method
to
GET and requestHeaders
to []
.
Since this function uses MonadThrow
, the return monad can be anything that is
an instance of MonadThrow
, such as IO
or Maybe
.
You can place the request method at the beginning of the URL separated by a space, e.g.:
@@
parseRequeset "POST http://httpbin.org/post"
@@
Note that the request method must be provided as all capital letters.
Request
created by this function won't cause exceptions on non-2XX
response status codes.
Since: 0.4.30
parseUrlThrow :: MonadThrow m => String -> m Request #
Same as parseRequest
, except will throw an HttpException
in
the event of a non-2XX response.
Since: 0.4.30
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) # | |