Streaming.hs

-- | This module provides classes that one has to implement in order to
-- use a streaming library such as Conduit for streaming.
module Hreq.Core.API.Streaming where

import Data.ByteString (ByteString)
import Hreq.Core.API.MediaType
import Hreq.Core.API.Response
import Hreq.Core.API.Verb

-- * Client Streaming

-- | A StreamVerb endpoint receives a stream of encoded values
-- with the OctetStream content type.
type StreamVerb method = Verb method '[ 'ResStream OctetStream () ]

-- * Stream synonyms
type StreamGet = StreamVerb GET
type StreamPost = StreamVerb POST
type StreamPut = StreamVerb PUT

-- * Request Body streaming

-- | A function which generates successive chunks of a request body,
-- provider a single empty bytestring when no more data is available.
type Pooper = IO ByteString

-- | A function which must be provided with a Popper.
type NeedsPooper a = Pooper -> IO a

-- | A datatype containing a function which will provide a 'Pooper' to a 'NeedsPooper'. .
newtype GivesPooper a
  = GivesPooper { runGivesPooper ::  NeedsPooper a -> IO a }

instance Show (GivesPooper a) where
  show _ = "GivesPooper <IO>"

instance Eq (GivesPooper a) where
  _ == _ = False

class HasStreamBody a where
  givePopper :: a -> GivesPooper ()