Data.Binary.IO

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

Reader

data ReaderError

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

Show ReaderError

Defined in Data.Binary.IO.Lifted

Methods

showsPrec :: Int -> ReaderError -> ShowS

show :: ReaderError -> String

showList :: [ReaderError] -> ShowS

Exception ReaderError

Defined in Data.Binary.IO.Lifted

Methods

toException :: ReaderError -> SomeException

fromException :: SomeException -> Maybe ReaderError

displayException :: ReaderError -> String

newtype Reader

Alias for Reader IO

Since: 0.0.1

Constructors

Reader

Fields

• unReader :: Reader IO

Instances

CanGet Reader IO

Defined in Data.Binary.IO

Methods

runGet :: Reader -> Get a -> IO a

newReader

Arguments

:: Handle

Handle that will be read from

-> IO Reader

Unlifted version of newReader

Since: 0.0.1

newReaderWith

Arguments

:: IO ByteString

Chunk producer

-> IO Reader

Unlifted version of newReaderWith.

Since: 0.1.1

Writer

newtype Writer

Since: 0.0.1

Constructors

Writer

Fields

• unWriter :: Writer IO

Instances

CanPut Writer IO

Defined in Data.Binary.IO

Methods

runPut :: Writer -> PutM a -> IO a

newWriter

Arguments

:: Handle

Handle that will be written to

-> Writer

Unlifted version of newWriter

Since: 0.0.1

newWriterWith

Arguments

:: (ByteString -> IO ())

Chunk handler

-> Writer

Unlifted version of newWriterWith

Since: 0.1.1

Pipe

newPipe :: IO (Reader, Writer)

Unlifted version of newPipe

Since: 0.2.0

Duplex

data Duplex

Since: 0.0.1

Constructors

Duplex

Fields

• duplexWriter :: !Writer
• duplexReader :: !Reader

Instances

CanPut Duplex IO

Defined in Data.Binary.IO

Methods

runPut :: Duplex -> PutM a -> IO a

CanGet Duplex IO

Defined in Data.Binary.IO

Methods

runGet :: Duplex -> Get a -> IO a

newDuplex

Arguments

:: Handle

Handle that will be read from and written to

-> IO Duplex

Unlifted version of newDuplex

Since: 0.0.1

newDuplexWith :: IO ByteString -> (ByteString -> IO ()) -> IO Duplex

Unlifted version of newDuplexWith

Since: 0.1.1

Classes

type CanGet r = CanGet r IO

Alias for CanGet r IO

Since: 0.0.1

runGet

Arguments

:: CanGet r

=> r

Reader / source

-> Get a

Operation to execute

-> IO a

Unlifted version of runGet

Since: 0.0.1

read

Arguments

:: (CanGet r, Binary a)

=> r

Read source

-> IO a

Unlifted version of read

Since: 0.0.1

isEmpty :: CanGet r => r -> IO Bool

Unlifted version of isEmpty

Since: 0.3.0

type CanPut w = CanPut w IO

Alias for CanPut w IO

Since: 0.0.1

runPut

Arguments

:: CanPut w

=> w

Writer / target

-> PutM a

Operation to execute

-> IO a

Unlifted version of runPut

Since: 0.0.1

write

Arguments

:: (CanPut w, Binary a)

=> w

Write target

-> a

Value to be written

-> IO ()

Unlifted version of write

Since: 0.0.1