Safe Haskell	None
Language	Haskell2010

Data.Binary.IO

Contents

Reader
Writer
Pipe
Duplex
Classes

Description

Read and write values of types that implement Binary from and to Handles

This module homes the unlifted API variant. For proper documentation check out the equally named functions in Data.Binary.IO.Lifted

Synopsis

data ReaderError = ReaderGetError {
- readerErrorRemaining :: !ByteString
- readerErrorOffset :: !ByteOffset
- readerErrorInput :: !ByteString
- readerErrorMessage :: !String
}
newtype Reader = Reader {
- unReader :: Reader IO
}
newReader :: Handle -> IO Reader
newReaderWith :: IO ByteString -> IO Reader
newtype Writer = Writer {
- unWriter :: Writer IO
}
newWriter :: Handle -> Writer
newWriterWith :: (ByteString -> IO ()) -> Writer
newPipe :: IO (Reader, Writer)
data Duplex = Duplex {
- duplexWriter :: !Writer
- duplexReader :: !Reader
}
newDuplex :: Handle -> IO Duplex
newDuplexWith :: IO ByteString -> (ByteString -> IO ()) -> IO Duplex
type CanGet r = CanGet r IO
runGet :: CanGet r => r -> Get a -> IO a
read :: (CanGet r, Binary a) => r -> IO a
isEmpty :: CanGet r => r -> IO Bool
type CanPut w = CanPut w IO
runPut :: CanPut w => w -> PutM a -> IO a
write :: (CanPut w, Binary a) => w -> a -> IO ()

Reader

data ReaderError Source #

An error that can occur during reading

Since: 0.4.0

Constructors

ReaderGetError	Error from the `Get` operation
Fields readerErrorRemaining :: !ByteString Unconsumed part of the byte stream Since: 0.4.0 readerErrorOffset :: !ByteOffset Error location represented as an offset into the input Since: 0.4.0 readerErrorInput :: !ByteString Input to the `Get` operation Since: 0.4.0 readerErrorMessage :: !String Error message Since: 0.4.0

Instances

Instances details

Show ReaderError Source #
Instance details Defined in Data.Binary.IO.Lifted Methods showsPrec :: Int -> ReaderError -> ShowS # show :: ReaderError -> String # showList :: [ReaderError] -> ShowS #
Exception ReaderError Source #
Instance details Defined in Data.Binary.IO.Lifted Methods toException :: ReaderError -> SomeException # fromException :: SomeException -> Maybe ReaderError # displayException :: ReaderError -> String #

newtype Reader Source #

Alias for Reader IO

Since: 0.0.1

Constructors

Reader
Fields unReader :: Reader IO

Instances

Instances details

CanGet Reader IO Source #
Instance details Defined in Data.Binary.IO Methods runGet :: Reader -> Get a -> IO a Source #

newReader Source #

Arguments

:: Handle	Handle that will be read from
-> IO Reader

Unlifted version of newReader

Since: 0.0.1

newReaderWith Source #

Arguments

:: IO ByteString	Chunk producer
-> IO Reader

Unlifted version of newReaderWith.

Since: 0.1.1

Writer

newtype Writer Source #

Since: 0.0.1

Constructors

Writer
Fields unWriter :: Writer IO

Instances

Instances details

CanPut Writer IO Source #
Instance details Defined in Data.Binary.IO Methods runPut :: Writer -> PutM a -> IO a Source #

newWriter Source #

Arguments

:: Handle	Handle that will be written to
-> Writer

Unlifted version of newWriter

Since: 0.0.1

newWriterWith Source #

Arguments

:: (ByteString -> IO ())	Chunk handler
-> Writer

Unlifted version of newWriterWith

Since: 0.1.1

Pipe

newPipe :: IO (Reader, Writer) Source #

Unlifted version of newPipe

Since: 0.2.0

Duplex

data Duplex Source #

Since: 0.0.1

Constructors

Duplex
Fields duplexWriter :: !Writer duplexReader :: !Reader

Instances

Instances details

CanPut Duplex IO Source #
Instance details Defined in Data.Binary.IO Methods runPut :: Duplex -> PutM a -> IO a Source #
CanGet Duplex IO Source #
Instance details Defined in Data.Binary.IO Methods runGet :: Duplex -> Get a -> IO a Source #