Safe Haskell	Safe-Inferred
Language	Haskell2010

Dahdit.Iface

Synopsis

class PrimMonad m => BinaryGetTarget z m where
- getTargetOffset :: ByteCount -> Get a -> z -> m (Either GetError a, ByteCount)
- getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb z m -> m (Either GetError a, ByteCount, ByteCount)
getTarget :: BinaryGetTarget z m => Get a -> z -> m (Either GetError a, ByteCount)
class BinaryGetTarget z m => BinaryPutTarget z m where
- putTargetUnsafe :: Put -> ByteCount -> m z
putTarget :: BinaryPutTarget z m => Put -> m z
class BinaryGetTarget z m => MutBinaryPutTarget z m where
- mutPutTargetOffsetUnsafe :: ByteCount -> Put -> ByteCount -> z -> m ByteCount
mutPutTargetOffset :: MutBinaryPutTarget z m => ByteCount -> Put -> z -> m ByteCount
mutPutTarget :: MutBinaryPutTarget z m => Put -> z -> m ByteCount
getEnd :: Get a -> Get a
decode :: (Binary a, BinaryGetTarget z m) => z -> m (Either GetError a, ByteCount)
decodeInc :: (Binary a, BinaryGetTarget z m) => Maybe ByteCount -> GetIncCb z m -> m (Either GetError a, ByteCount, ByteCount)
decodeEnd :: (Binary a, BinaryGetTarget z m) => z -> m (Either GetError a, ByteCount)
decodeFile :: Binary a => FilePath -> IO (Either GetError a, ByteCount)
decodeFileEnd :: Binary a => FilePath -> IO (Either GetError a, ByteCount)
encode :: (Binary a, BinaryPutTarget z m) => a -> m z
encodeFile :: Binary a => a -> FilePath -> IO ()
mutEncode :: (Binary a, MutBinaryPutTarget z m) => a -> z -> m ByteCount

Documentation

class PrimMonad m => BinaryGetTarget z m where Source #

Abstracts over the sources we can read from.

Methods

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

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.

getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb z m -> m (Either GetError a, ByteCount, ByteCount) Source #

Get a value incrementally from sources yielded by the given callback, returning a result, final offset in the whole stream, and final offset in the current chunk. Takes an optional maximum capacity.

Instances

Instances details

BinaryGetTarget ByteString IO Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> ByteString -> IO (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb ByteString IO -> IO (Either GetError a, ByteCount, ByteCount) Source #
PrimMonad m => BinaryGetTarget ShortByteString m Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> ShortByteString -> m (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb ShortByteString m -> m (Either GetError a, ByteCount, ByteCount) Source #
PrimMonad m => BinaryGetTarget ByteArray m Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> ByteArray -> m (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb ByteArray m -> m (Either GetError a, ByteCount, ByteCount) Source #
BinaryGetTarget Text IO Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> Text -> IO (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb Text IO -> IO (Either GetError a, ByteCount, ByteCount) Source #
BinaryGetTarget String IO Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> String -> IO (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb String IO -> IO (Either GetError a, ByteCount, ByteCount) Source #
MonadPrim s m => BinaryGetTarget (MutableByteArray s) m Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> MutableByteArray s -> m (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb (MutableByteArray s) m -> m (Either GetError a, ByteCount, ByteCount) Source #
BinaryGetTarget (Vector Word8) IO Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> Vector Word8 -> IO (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb (Vector Word8) IO -> IO (Either GetError a, ByteCount, ByteCount) Source #
BinaryGetTarget (IOVector Word8) IO Source #
Instance details Defined in Dahdit.Iface Methods getTargetOffset :: ByteCount -> Get a -> IOVector Word8 -> IO (Either GetError a, ByteCount) Source # getTargetInc :: Maybe ByteCount -> Get a -> GetIncCb (IOVector Word8) IO -> IO (Either GetError a, ByteCount, ByteCount) Source #

getTarget :: BinaryGetTarget z m => Get a -> z -> m (Either GetError a, ByteCount) Source #

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

class BinaryGetTarget z m => BinaryPutTarget z m where Source #

Abstracts over the immutable sinks we can render to.

Methods

putTargetUnsafe :: Put -> ByteCount -> m z Source #

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

Instances

Instances details

BinaryPutTarget ByteString IO Source #
Instance details Defined in Dahdit.Iface Methods putTargetUnsafe :: Put -> ByteCount -> IO ByteString Source #
PrimMonad m => BinaryPutTarget ShortByteString m Source #
Instance details Defined in Dahdit.Iface Methods putTargetUnsafe :: Put -> ByteCount -> m ShortByteString Source #
PrimMonad m => BinaryPutTarget ByteArray m Source #
Instance details Defined in Dahdit.Iface Methods putTargetUnsafe :: Put -> ByteCount -> m ByteArray Source #
BinaryPutTarget Text IO Source #
Instance details Defined in Dahdit.Iface Methods putTargetUnsafe :: Put -> ByteCount -> IO Text Source #
BinaryPutTarget String IO Source #
Instance details Defined in Dahdit.Iface Methods putTargetUnsafe :: Put -> ByteCount -> IO String Source #
BinaryPutTarget (Vector Word8) IO Source #
Instance details Defined in Dahdit.Iface Methods putTargetUnsafe :: Put -> ByteCount -> IO (Vector Word8) Source #

putTarget :: BinaryPutTarget z m => Put -> m z Source #

Put an action to the sink with calculated capacity.

class BinaryGetTarget z m => MutBinaryPutTarget z m where Source #

Methods

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

Instances

Instances details

MonadPrim s m => MutBinaryPutTarget (MutableByteArray s) m Source #
Instance details Defined in Dahdit.Iface Methods mutPutTargetOffsetUnsafe :: ByteCount -> Put -> ByteCount -> MutableByteArray s -> m ByteCount Source #
MutBinaryPutTarget (IOVector Word8) IO Source #
Instance details Defined in Dahdit.Iface Methods mutPutTargetOffsetUnsafe :: ByteCount -> Put -> ByteCount -> IOVector Word8 -> IO ByteCount Source #