Morley.Util.Binary

This module contains helper functions to deal with encoding and decoding of binary data.

Documentation

newtype UnpackError

Any decoding error.

Constructors

UnpackError

Fields

• unUnpackError :: Text

Instances

Exception UnpackError

Defined in Morley.Util.Binary

Methods

toException :: UnpackError -> SomeException

fromException :: SomeException -> Maybe UnpackError

displayException :: UnpackError -> String

Show UnpackError

Defined in Morley.Util.Binary

Methods

showsPrec :: Int -> UnpackError -> ShowS

show :: UnpackError -> String

showList :: [UnpackError] -> ShowS

Buildable UnpackError

Defined in Morley.Util.Binary

Methods

build :: UnpackError -> Builder

Eq UnpackError

Defined in Morley.Util.Binary

Methods

(==) :: UnpackError -> UnpackError -> Bool

(/=) :: UnpackError -> UnpackError -> Bool

ensureEnd :: Get ()

launchGet :: Get a -> LByteString -> Either UnpackError a

type TaggedDecoder a = TaggedDecoderM IdentityT a

Specialization of TaggedDecoderM to IdentityT transformer.

data TaggedDecoderM t a

Describes how decodeWithTagM should decode tag-dependent data. We expect bytes of such structure: tdTag followed by a bytestring which will be parsed with tdDecoder.

Constructors

TaggedDecoder

Fields

• tdTag :: Word8
• tdDecoder :: t Get a

(#:) :: Word8 -> Get a -> TaggedDecoder a infixr 0

Alias for TaggedDecoder constructor specialized to Get

(##:) :: Word8 -> t Get a -> TaggedDecoderM t a infixr 0

Alias for TaggedDecoder constructor.

decodeBytesLike :: Buildable err => String -> (ByteString -> Either err a) -> Get a

decodeWithTag :: String -> [TaggedDecoder a] -> Get a

Common decoder for the case when packed data starts with a tag (1 byte) that specifies how to decode remaining data.

This is a version of decodeWithTagM specialized to naked Get monad.

decodeWithTagM :: (MonadTrans t, Monad (t Get)) => String -> (Word8 -> t Get a) -> [TaggedDecoderM t a] -> t Get a

Common decoder for the case when packed data starts with a tag (1 byte) that specifies how to decode remaining data.

This is a general version of decodeWithTag that allows Get to be wrapped in a monad transformer.

getByteStringCopy :: Int -> Get ByteString

Get a bytestring of the given length leaving no references to the original data in serialized form.

getRemainingByteStringCopy :: Get ByteString

Get remaining available bytes.

Note that reading all remaining decoded input may be expensive and is thus discouraged, use can use this function only when you know that amount of data to be consumed is limited, e.g. within decodeBytesLike call.

unknownTag :: String -> Word8 -> Get a

Fail with "unknown tag" error.