Dahdit.Iface

Documentation

class BinaryTarget z where

Abstracts over the sources we can read from / sinks we can render to.

Methods

putTargetUnsafe :: Put -> ByteCount -> z

Put an action to the sink with the given length. Prefer putTarget to safely count capacity, or use encode to use byte size.

getTargetOffset :: ByteCount -> Get a -> z -> (Either GetError a, ByteCount)

Get a value from the source given a starting offset, returning a result and final offset. On error, the offset will indicate where in the source the error occurred.

Instances

BinaryTarget ByteString

Defined in Dahdit.Iface

Methods

putTargetUnsafe :: Put -> ByteCount -> ByteString

getTargetOffset :: ByteCount -> Get a -> ByteString -> (Either GetError a, ByteCount)

BinaryTarget ShortByteString

Defined in Dahdit.Iface

Methods

putTargetUnsafe :: Put -> ByteCount -> ShortByteString

getTargetOffset :: ByteCount -> Get a -> ShortByteString -> (Either GetError a, ByteCount)

BinaryTarget ByteArray

Defined in Dahdit.Iface

Methods

putTargetUnsafe :: Put -> ByteCount -> ByteArray

getTargetOffset :: ByteCount -> Get a -> ByteArray -> (Either GetError a, ByteCount)

BinaryTarget (Vector Word8)

Defined in Dahdit.Iface

Methods

putTargetUnsafe :: Put -> ByteCount -> Vector Word8

getTargetOffset :: ByteCount -> Get a -> Vector Word8 -> (Either GetError a, ByteCount)

getTarget :: BinaryTarget z => Get a -> z -> (Either GetError a, ByteCount)

Get a value from the source, returning a result and final offset.

putTarget :: BinaryTarget z => Put -> z

Put an action to the sink with calculated capacity.

class MutBinaryTarget m z where

Methods

mutPutTargetOffsetUnsafe :: ByteCount -> Put -> ByteCount -> z -> m ByteCount

Instances

(PrimBase m, s ~ PrimState m) => MutBinaryTarget m (MutableByteArray s)

Defined in Dahdit.Iface

Methods

mutPutTargetOffsetUnsafe :: ByteCount -> Put -> ByteCount -> MutableByteArray s -> m ByteCount

(PrimBase m, s ~ PrimState m) => MutBinaryTarget m (MVector s Word8)

Defined in Dahdit.Iface

Methods

mutPutTargetOffsetUnsafe :: ByteCount -> Put -> ByteCount -> MVector s Word8 -> m ByteCount

mutPutTargetOffset :: MutBinaryTarget m z => ByteCount -> Put -> z -> m ByteCount

mutPutTarget :: MutBinaryTarget m z => Put -> z -> m ByteCount

decode :: (Binary a, BinaryTarget z) => z -> (Either GetError a, ByteCount)

Decode a value from a source returning a result and consumed byte count.

decodeFile :: Binary a => FilePath -> IO (Either GetError a, ByteCount)

Decode a value from a file.

encode :: (Binary a, ByteSized a, BinaryTarget z) => a -> z

Encode a value to a sink.

encodeFile :: (Binary a, ByteSized a) => a -> FilePath -> IO ()

Encode a value to a file.

mutEncode :: (Binary a, ByteSized a, MutBinaryTarget m z) => a -> z -> m ByteCount

Encode a value to a mutable buffer, returning number of bytes filled.