| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Data.Conduit.Serialization.Binary
- conduitDecode :: (Binary b, MonadThrow m) => Conduit ByteString m b
- conduitEncode :: (Binary b, MonadThrow m) => Conduit b m ByteString
- conduitMsgEncode :: Monad m => Binary b => Conduit b m ByteString
- conduitGet :: MonadThrow m => Get b -> Conduit ByteString m b
- conduitPut :: Monad m => Conduit Put m ByteString
- conduitPutList :: Monad m => Conduit Put m [ByteString]
- conduitPutLBS :: Monad m => Conduit Put m ByteString
- conduitPutMany :: Monad m => Conduit Put m (Vector ByteString)
- sourcePut :: Monad m => Put -> Producer m ByteString
- sinkGet :: MonadThrow m => Get b -> Consumer ByteString m b
- data ParseError = ParseError {}
Documentation
conduitDecode :: (Binary b, MonadThrow m) => Conduit ByteString m b Source #
Runs default Decoder repeatedly on a input stream.
conduitEncode :: (Binary b, MonadThrow m) => Conduit b m ByteString Source #
Runs default encoder on a input stream.
This function produces a stream of bytes where for each input
value you will have a number of ByteStrings, and no boundary
between different values.
conduitMsgEncode :: Monad m => Binary b => Conduit b m ByteString Source #
Runs default encoder on input stream.
This function produces a ByteString per each incomming packet, it may be useful in datagram based protocols. Function maintains following property
'conduitMsgEncode' xs == 'CL.map' 'Data.ByteString.encode' =$= 'CL.map' 'LBS.toStrict'
This invariant is maintaind by the cost of additional data copy,
so if you packets can be serialized to the large data chunks or
you interested in iterative packet serialization
concider using conduitPutList or conduitPutMany
conduitGet :: MonadThrow m => Get b -> Conduit ByteString m b Source #
Runs getter repeatedly on a input stream.
conduitPut :: Monad m => Conduit Put m ByteString Source #
Runs putter repeatedly on a input stream, returns an output stream.
conduitPutList :: Monad m => Conduit Put m [ByteString] Source #
Vectorized variant of conduitPut returning list contains
all chunks from one element representation
conduitPutLBS :: Monad m => Conduit Put m ByteString Source #
Runs putter repeatedly on a input stream.
Returns a lazy butestring so it's possible to use vectorized
IO on the result either by calling' LBS.toChunks' or by
calling send.
conduitPutMany :: Monad m => Conduit Put m (Vector ByteString) Source #
Vectorized variant of conduitPut.
sourcePut :: Monad m => Put -> Producer m ByteString Source #
Create stream of strict bytestrings from Put value.
sinkGet :: MonadThrow m => Get b -> Consumer ByteString m b Source #
Decode message from input stream.
data ParseError Source #
Constructors
| ParseError | |
Fields
| |
Instances