Streaming.Binary

This module implements a method to ingest a sequence of Data.Binary encoded records using bounded memory. Minimal example:

{-# LANGUAGE TypeApplications #-}

import Data.Function ((&))
import qualified Data.ByteString.Streaming as Q
import Streaming
import Streaming.Binary
import qualified Streaming.Prelude as S

-- Interpret all bytes on stdin as a sequence of integers.
-- Print them on-the-fly on stdout.
main = Q.getContents & decoded @Int & S.print

Documentation

decode :: (Binary a, Monad m) => ByteString m r -> m (ByteString m r, Int64, Either String a)

decodeWith :: Monad m => Get a -> ByteString m r -> m (ByteString m r, Int64, Either String a)

decoded :: (Binary a, Monad m) => ByteString m r -> Stream (Of a) m (ByteString m r, Int64, Either String r)

decodedWith :: Monad m => Get a -> ByteString m r -> Stream (Of a) m (ByteString m r, Int64, Either String r)

encode :: (Binary a, MonadIO m) => a -> ByteString m ()

encodeWith :: MonadIO m => (a -> Put) -> a -> ByteString m ()

encoded :: (Binary a, MonadIO m) => Stream (Of a) IO () -> ByteString m ()

encodedWith :: MonadIO m => (a -> Put) -> Stream (Of a) IO () -> ByteString m ()