Data.Streaming.Blaze

Convert a stream of blaze-builder Builders into a stream of ByteStrings.

Adapted from blaze-builder-enumerator, written by myself and Simon Meier.

Note that the functions here can work in any monad built on top of IO or ST.

Documentation

type BlazeRecv = Builder -> IO BlazePopper

type BlazePopper = IO ByteString

Provides a series of ByteStrings until empty, at which point it provides an empty ByteString.

Since 0.1.2

type BlazeFinish = IO (Maybe ByteString)

newBlazeRecv :: BufferAllocStrategy -> IO (BlazeRecv, BlazeFinish)

Buffers

data Buffer :: *

Status information

freeSize :: Buffer -> Int

sliceSize :: Buffer -> Int

bufferSize :: Buffer -> Int

Creation and modification

allocBuffer :: Int -> IO Buffer

reuseBuffer :: Buffer -> Buffer

nextSlice :: Int -> Buffer -> Maybe Buffer

Conversion to bytestings

unsafeFreezeBuffer :: Buffer -> ByteString

unsafeFreezeNonEmptyBuffer :: Buffer -> Maybe ByteString

Buffer allocation strategies

type BufferAllocStrategy = (IO Buffer, Int -> Buffer -> IO (IO Buffer))

allNewBuffersStrategy :: Int -> BufferAllocStrategy

reuseBufferStrategy :: IO Buffer -> BufferAllocStrategy

defaultStrategy :: BufferAllocStrategy