| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Data.Streaming.Blaze
Contents
Description
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.
- type BlazeRecv = Builder -> IO BlazePopper
- type BlazePopper = IO ByteString
- type BlazeFinish = IO (Maybe ByteString)
- newBlazeRecv :: BufferAllocStrategy -> IO (BlazeRecv, BlazeFinish)
- data Buffer :: *
- freeSize :: Buffer -> Int
- sliceSize :: Buffer -> Int
- bufferSize :: Buffer -> Int
- allocBuffer :: Int -> IO Buffer
- reuseBuffer :: Buffer -> Buffer
- nextSlice :: Int -> Buffer -> Maybe Buffer
- unsafeFreezeBuffer :: Buffer -> ByteString
- unsafeFreezeNonEmptyBuffer :: Buffer -> Maybe ByteString
- type BufferAllocStrategy = (IO Buffer, Int -> Buffer -> IO (IO Buffer))
- allNewBuffersStrategy :: Int -> BufferAllocStrategy
- reuseBufferStrategy :: IO Buffer -> BufferAllocStrategy
- defaultStrategy :: BufferAllocStrategy
Documentation
type BlazeRecv = Builder -> IO BlazePopper Source
type BlazePopper = IO ByteString Source
Provides a series of ByteStrings until empty, at which point it provides
an empty ByteString.
Since 0.1.2
type BlazeFinish = IO (Maybe ByteString) Source
Buffers
data Buffer :: *
A buffer Buffer fpbuf p0 op ope describes a buffer with the underlying
byte array fpbuf..ope, the currently written slice p0..op and the free
space op..ope.
Status information
bufferSize :: Buffer -> Int
The size of the whole byte array underlying the buffer.
Creation and modification
allocBuffer :: Int -> IO Buffer
allocBuffer size allocates a new buffer of size size.
reuseBuffer :: Buffer -> Buffer
Resets the beginning of the next slice and the next free byte such that the whole buffer can be filled again.
nextSlice :: Int -> Buffer -> Maybe Buffer
Move the beginning of the slice to the next free byte such that the remaining free space of the buffer can be filled further. This operation is safe and can be used to fill the remaining part of the buffer after a direct insertion of a bytestring or a flush.
Conversion to bytestings
unsafeFreezeBuffer :: Buffer -> ByteString
Convert the buffer to a bytestring. This operation is unsafe in the sense that created bytestring shares the underlying byte array with the buffer. Hence, depending on the later use of this buffer (e.g., if it gets reset and filled again) referential transparency may be lost.
unsafeFreezeNonEmptyBuffer :: Buffer -> Maybe ByteString
Convert a buffer to a non-empty bytestring. See unsafeFreezeBuffer for
the explanation of why this operation may be unsafe.
Buffer allocation strategies
type BufferAllocStrategy = (IO Buffer, Int -> Buffer -> IO (IO Buffer))
A buffer allocation strategy (buf0, nextBuf) specifies the initial
buffer to use and how to compute a new buffer nextBuf minSize buf with at
least size minSize from a filled buffer buf. The double nesting of the
IO monad helps to ensure that the reference to the filled buffer buf is
lost as soon as possible, but the new buffer doesn't have to be allocated
too early.
allNewBuffersStrategy :: Int -> BufferAllocStrategy
The simplest buffer allocation strategy: whenever a buffer is requested, allocate a new one that is big enough for the next build step to execute.
NOTE that this allocation strategy may spill quite some memory upon direct insertion of a bytestring by the builder. Thats no problem for garbage collection, but it may lead to unreasonably high memory consumption in special circumstances.
reuseBufferStrategy :: IO Buffer -> BufferAllocStrategy
An unsafe, but possibly more efficient buffer allocation strategy: reuse the buffer, if it is big enough for the next build step to execute.