BinaryFiles

Documentation

data Endianness

Constructors

BigEndian

LittleEndian

Instances

Eq Endianness

Show Endianness

HasEndianness Endianness

class HasEndianness hasEndianness where

Methods

considerEndianness :: hasEndianness -> Endianness

Instances

HasEndianness Endianness

class Serializable context a where

Methods

serialize :: a -> ContextualSerialization context ()

deserialize :: ContextualDeserialization context a

type Serialization a = forall context. ContextualSerialization context a

type Deserialization a = forall context. ContextualDeserialization context a

data ContextualSerialization context a

Instances

MonadSerialWriter ContextualSerialization

MonadSerial ContextualSerialization

Monad (ContextualSerialization context)

data ContextualDeserialization context a

Instances

MonadSerialReader ContextualDeserialization

MonadSerial ContextualDeserialization

Monad (ContextualDeserialization context)

data SomeSerializationFailure

Constructors

forall failure . SerializationFailure failure => SomeSerializationFailure failure

Instances

Show SomeSerializationFailure

Typeable SomeSerializationFailure

SerializationFailure SomeSerializationFailure

class (Show failure, Typeable failure) => SerializationFailure failure where

Methods

toSerializationFailure :: failure -> SomeSerializationFailure

fromSerializationFailure :: SomeSerializationFailure -> Maybe failure

Instances

SerializationFailure InsufficientDataSerializationFailure

SerializationFailure OutOfRangeSerializationFailure

SerializationFailure LowLevelSerializationFailure

SerializationFailure SomeSerializationFailure

data LowLevelSerializationFailure

Constructors

LowLevelSerializationFailure IOException

Instances

Show LowLevelSerializationFailure

Typeable LowLevelSerializationFailure

SerializationFailure LowLevelSerializationFailure

data OutOfRangeSerializationFailure

Constructors

OutOfRangeSerializationFailure Int

Instances

Show OutOfRangeSerializationFailure

Typeable OutOfRangeSerializationFailure

SerializationFailure OutOfRangeSerializationFailure

data InsufficientDataSerializationFailure

Constructors

InsufficientDataSerializationFailure Int

Instances

Show InsufficientDataSerializationFailure

Typeable InsufficientDataSerializationFailure

SerializationFailure InsufficientDataSerializationFailure

class MonadSerial m where

Methods

getContext :: forall context. Monad (m context) => m context context

withContext :: forall context context' a. (Monad (m context), Monad (m context')) => context' -> m context' a -> m context a

getTags :: forall context. Monad (m context) => m context [(Int, String)]

withTag :: forall context a. Monad (m context) => String -> m context a -> m context a

withWindow :: forall context a. Monad (m context) => SerialOrigin -> Int -> Int -> m context a -> m context a

throw :: forall context failure a. (Monad (m context), SerializationFailure failure) => failure -> m context a

catch :: forall context failure a. (Monad (m context), SerializationFailure failure) => m context a -> (Int -> [(Int, String)] -> failure -> m context a) -> m context a

seek :: SerialOrigin -> Int -> m context ()

tell :: m context Int

isEOF :: m context Bool

Instances

MonadSerial ContextualDeserialization

MonadSerial ContextualSerialization

MonadSerial (BackendSpecificDeserialization FilePath)

MonadSerial (BackendSpecificDeserialization ByteString)

MonadSerial (BackendSpecificSerialization FilePath)

MonadSerial (BackendSpecificSerialization ByteString)

data SerialOrigin

Constructors

OffsetFromStart

OffsetFromCurrent

OffsetFromEnd

Instances

Eq SerialOrigin

Ord SerialOrigin

Show SerialOrigin

read :: MonadSerialReader m => Int -> m context ByteString

write :: MonadSerialWriter m => ByteString -> m context ()

runSerializationToByteString :: ContextualSerialization () a -> Either (Int, [(Int, String)], SomeSerializationFailure) (a, ByteString)

runSerializationToFile :: ContextualSerialization () a -> FilePath -> IO (Either (Int, [(Int, String)], SomeSerializationFailure) a)

runDeserializationFromByteString :: ContextualDeserialization () a -> ByteString -> Either (Int, [(Int, String)], SomeSerializationFailure) a

runDeserializationFromFile :: ContextualDeserialization () a -> FilePath -> IO (Either (Int, [(Int, String)], SomeSerializationFailure) a)

runSubDeserializationFromByteString :: ContextualDeserialization () a -> ByteString -> Deserialization a

toByteString :: Serializable () a => a -> Either (Int, [(Int, String)], SomeSerializationFailure) ByteString

toFile :: Serializable () a => a -> FilePath -> IO (Maybe (Int, [(Int, String)], SomeSerializationFailure))

fromByteString :: Serializable () a => ByteString -> Either (Int, [(Int, String)], SomeSerializationFailure) a

fromFile :: Serializable () a => FilePath -> IO (Either (Int, [(Int, String)], SomeSerializationFailure) a)

serializeWord :: (Bits word, Integral word, Num word, HasEndianness context) => word -> ContextualSerialization context ()

deserializeWord :: forall word context. (Bits word, Integral word, Num word, HasEndianness context) => ContextualDeserialization context word

serializeNullTerminatedText :: ByteString -> Serialization ()

deserializeNullTerminatedText :: Deserialization ByteString

serializeNullPaddedText :: Int -> ByteString -> Serialization ()

deserializeNullPaddedText :: Int -> Deserialization ByteString