Hreq.Core.API.Streaming

This module provides classes that one has to implement in order to use a streaming library such as Conduit for streaming.

Client Streaming

type StreamVerb method = Verb method '[ResStream OctetStream ()]

A StreamVerb endpoint receives a stream of encoded values with the OctetStream content type.

Stream synonyms

type StreamGet = StreamVerb GET

type StreamPost = StreamVerb POST

type StreamPut = StreamVerb PUT

Request Body streaming

type Pooper = IO ByteString

A function which generates successive chunks of a request body, provider a single empty bytestring when no more data is available.

type NeedsPooper a = Pooper -> IO a

A function which must be provided with a Popper.

newtype GivesPooper a

A datatype containing a function which will provide a Pooper to a NeedsPooper. .

Constructors

GivesPooper

Fields

• runGivesPooper :: NeedsPooper a -> IO a

Instances

Eq (GivesPooper a)

Defined in Hreq.Core.API.Streaming

Methods

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

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

Show (GivesPooper a)

Defined in Hreq.Core.API.Streaming

Methods

showsPrec :: Int -> GivesPooper a -> ShowS

show :: GivesPooper a -> String

showList :: [GivesPooper a] -> ShowS

class HasStreamBody a where

Methods

givePopper :: a -> GivesPooper ()