Control.Quiver.ByteString

When binary data is streamed through a Quiver processor, it's often partitioned arbitrarily into packets with no semantic significance, beyond facilitation of processing in constant space. This is similar to the chunking mechanism within lazy bytestrings, and, accordingly, it's often convenient to unify the two mechanisms, by converting between processors over lazy bytestrings and processors over strict chunks of these bytestrings. This module provides efficient implementations of these conversions.

Documentation

toChunks :: Functor f => SP Lazy.ByteString ByteString.ByteString f ()

A processors that converts a stream of lazy bytestrings into a stream of their chunks.

fromChunks :: Functor f => Int64 -> Int64 -> SP ByteString.ByteString Lazy.ByteString f [ByteString.ByteString]

A processors that converts a stream of strict bytestring chunks into a stream of lazy bytestrings with the specified minimum and maximum size, without copying any data. If the input does not provide enough data to complete the final byte string of the minimum requested length, the stream processor will fail with the incomplete list of chunks.

fromChunks' :: Monad f => Int64 -> Int64 -> SP ByteString.ByteString Lazy.ByteString f e

A processors that converts a stream of strict bytestring chunks into a stream of lazy bytestrings with the specified minimum and maximum size, without copying any data. This processor always emits all of its input, so if the input does not provide enough data to complete the final byte string of the minimum requested length, the final byte string emitted by the stream will be shorter than the requested minimum.