Freckle.App.Http.Cache.Gzip

Type and functions for handling gzipped HTTP responses

In order to optimize caching of responses in storage with size limitations, we cache gzipped responses as-is. This requires disabling the automatic decompression of http-client and handling it ourselves.

The module makes that a type-enforced process:

• requestPotentiallyGzipped is the only way to get a PotentiallyGzipped
• Which is the type needed for the response field in CachedResponse
• gunzipResponseBody is the only way to erase PotentiallyGzipped
• Which is what you actually need to return

Documentation

data PotentiallyGzipped a

Instances

Show a => Show (PotentiallyGzipped a)

Defined in Freckle.App.Http.Cache.Gzip

Methods

showsPrec :: Int -> PotentiallyGzipped a -> ShowS

show :: PotentiallyGzipped a -> String

showList :: [PotentiallyGzipped a] -> ShowS

Eq a => Eq (PotentiallyGzipped a)

Defined in Freckle.App.Http.Cache.Gzip

Methods

(==) :: PotentiallyGzipped a -> PotentiallyGzipped a -> Bool

(/=) :: PotentiallyGzipped a -> PotentiallyGzipped a -> Bool

Serialise a => Serialise (PotentiallyGzipped a)

Defined in Freckle.App.Http.Cache.Gzip

Methods

encode :: PotentiallyGzipped a -> Encoding

decode :: Decoder s (PotentiallyGzipped a)

encodeList :: [PotentiallyGzipped a] -> Encoding

decodeList :: Decoder s [PotentiallyGzipped a]

requestPotentiallyGzipped :: Functor m => (Request -> m (Response body)) -> Request -> m (Response (PotentiallyGzipped body))

Run a request without automatic decompress and tag the body type

gunzipResponseBody :: MonadIO m => Request -> Response (PotentiallyGzipped ByteString) -> m (Response ByteString)

Gunzip a PotentiallyGzipped body, if necessary