Safe Haskell	Safe-Inferred
Language	Haskell2010

Flat.Decoder

Description

Strict Decoder

Synopsis

strictDecoder :: Get a -> ByteString -> Int -> Either DecodeException a
listTDecoder :: Get a -> ByteString -> IO (ListT IO a)
type Decoded a = Either DecodeException a
data DecodeException
- = NotEnoughSpace Env
- | TooMuchSpace Env
- | BadEncoding Env String
- | BadOp String
data Get a
dByteString :: Get ByteString
dLazyByteString :: Get ByteString
dShortByteString :: Get ShortByteString
dShortByteString_ :: Get ShortByteString
dUTF16 :: Get Text
dUTF8 :: Get Text
decodeArrayWith :: Get a -> Get [a]
decodeListWith :: Get a -> Get [a]
dFloat :: Get Float
dDouble :: Get Double
dInteger :: Get Integer
dNatural :: Get Natural
dChar :: Get Char
dBool :: Get Bool
dWord8 :: Get Word8
dWord16 :: Get Word16
dWord32 :: Get Word32
dWord64 :: Get Word64
dWord :: Get Word
dInt8 :: Get Int8
dInt16 :: Get Int16
dInt32 :: Get Int32
dInt64 :: Get Int64
dInt :: Get Int
dBE8 :: Get Word8
dBE16 :: Get Word16
dBE32 :: Get Word32
dBE64 :: Get Word64
dBEBits8 :: Int -> Get Word8
dBEBits16 :: Int -> Get Word16
dBEBits32 :: Int -> Get Word32
dBEBits64 :: Int -> Get Word64
dropBits :: Int -> Get ()
data ConsState = ConsState !Word !Int
consOpen :: Get ConsState
consClose :: Int -> Get ()
consBool :: ConsState -> (ConsState, Bool)
consBits :: ConsState -> Int -> (ConsState, Word)

Documentation

strictDecoder :: Get a -> ByteString -> Int -> Either DecodeException a Source #

Given a decoder and an input buffer returns either the decoded value or an error (if the input buffer is not fully consumed)

listTDecoder :: Get a -> ByteString -> IO (ListT IO a) Source #

Decode a list of values, one value at a time.

Useful in case that the decoded values takes a lot more memory than the encoded ones.

See ../test/Big.hs for a test and an example of use.

Instances

Instances details

Exception DecodeException Source #
Instance details Defined in Flat.Decoder.Types Methods toException :: DecodeException -> SomeException Source # fromException :: SomeException -> Maybe DecodeException Source # displayException :: DecodeException -> String Source #
Show DecodeException Source #
Instance details Defined in Flat.Decoder.Types Methods showsPrec :: Int -> DecodeException -> ShowS Source # show :: DecodeException -> String Source # showList :: [DecodeException] -> ShowS Source #
Eq DecodeException Source #
Instance details Defined in Flat.Decoder.Types Methods (==) :: DecodeException -> DecodeException -> Bool Source # (/=) :: DecodeException -> DecodeException -> Bool Source #
Ord DecodeException Source #
Instance details Defined in Flat.Decoder.Types Methods compare :: DecodeException -> DecodeException -> Ordering Source # (<) :: DecodeException -> DecodeException -> Bool Source # (<=) :: DecodeException -> DecodeException -> Bool Source # (>) :: DecodeException -> DecodeException -> Bool Source # (>=) :: DecodeException -> DecodeException -> Bool Source # max :: DecodeException -> DecodeException -> DecodeException Source # min :: DecodeException -> DecodeException -> DecodeException Source #

data Get a Source #

A decoder.

Given:

end of input buffer
current position in input buffer

Returns:

decoded value
new position in input buffer

Instances

Instances details

MonadFail Get Source #
Instance details Defined in Flat.Decoder.Types Methods fail :: String -> Get a Source #
Applicative Get Source #
Instance details Defined in Flat.Decoder.Types Methods pure :: a -> Get a Source # (<>) :: Get (a -> b) -> Get a -> Get b Source # liftA2 :: (a -> b -> c) -> Get a -> Get b -> Get c Source # (>) :: Get a -> Get b -> Get b Source # (<*) :: Get a -> Get b -> Get a Source #
Functor Get Source #
Instance details Defined in Flat.Decoder.Types Methods fmap :: (a -> b) -> Get a -> Get b Source # (<$) :: a -> Get b -> Get a Source #
Monad Get Source #
Instance details Defined in Flat.Decoder.Types Methods (>>=) :: Get a -> (a -> Get b) -> Get b Source # (>>) :: Get a -> Get b -> Get b Source # return :: a -> Get a Source #
Show (Get a) Source #
Instance details Defined in Flat.Decoder.Types Methods showsPrec :: Int -> Get a -> ShowS Source # show :: Get a -> String Source # showList :: [Get a] -> ShowS Source #
NFData (Get a) Source #
Instance details Defined in Flat.Decoder.Types Methods rnf :: Get a -> () Source #

dByteString :: Get ByteString Source #

dLazyByteString :: Get ByteString Source #

dShortByteString :: Get ShortByteString Source #

dShortByteString_ :: Get ShortByteString Source #

dUTF16 :: Get Text Source #

dUTF8 :: Get Text Source #

decodeArrayWith :: Get a -> Get [a] Source #

decodeListWith :: Get a -> Get [a] Source #

dFloat :: Get Float Source #

Decode a Float

dDouble :: Get Double Source #

Decode a Double

dInteger :: Get Integer Source #

dNatural :: Get Natural Source #

dChar :: Get Char Source #

dBool :: Get Bool Source #

Decode a boolean

dWord8 :: Get Word8 Source #

Return the 8 most significant bits (same as dBE8)

dWord16 :: Get Word16 Source #

dWord32 :: Get Word32 Source #

dWord64 :: Get Word64 Source #

dWord :: Get Word Source #

dInt8 :: Get Int8 Source #

dInt16 :: Get Int16 Source #

dInt32 :: Get Int32 Source #

dInt64 :: Get Int64 Source #

dInt :: Get Int Source #

dBE8 :: Get Word8 Source #

Return the 8 most significant bits

dBE16 :: Get Word16 Source #

Return the 16 most significant bits

dBE32 :: Get Word32 Source #

Return the 32 most significant bits

dBE64 :: Get Word64 Source #

Return the 64 most significant bits

dBEBits8 :: Int -> Get Word8 Source #

Return the n most significant bits (up to maximum of 8)

The bits are returned right shifted:

>>> unflatWith (dBEBits8 3) [0b11100001::Word8] == Right 0b00000111
True

>>> unflatWith (dBEBits8 9) [0b11100001::Word8,0b11111111]
Left (BadOp "read8: cannot read 9 bits")

dBEBits16 :: Int -> Get Word16 Source #

Return the n most significant bits (up to maximum of 16)

The bits are returned right shifted:

>>> pPrint . asBits <$> unflatWith (dBEBits16 11) [0b10110111::Word8,0b11100001]
Right 00000101 10111111

If more than 16 bits are requested, only the last 16 are returned:

>>> pPrint . asBits <$> unflatWith (dBEBits16 19) [0b00000000::Word8,0b11111111,0b11100001]
Right 00000111 11111111

dBEBits32 :: Int -> Get Word32 Source #

Return the n most significant bits (up to maximum of 32) The bits are returned right shifted.

dBEBits64 :: Int -> Get Word64 Source #

Return the n most significant bits (up to maximum of 64) The bits are returned right shifted.

dropBits :: Int -> Get () Source #

Drop the specified number of bits

data ConsState Source #

A special state, optimised for constructor decoding.

It consists of:

The bits to parse, the top bit being the first to parse (could use a Word16 instead, no difference in performance)
The number of decoded bits

Supports up to 512 constructors (9 bits).

Constructors

ConsState !Word !Int

consOpen :: Get ConsState Source #

Switch to constructor decoding {-# INLINE consOpen #-}

consClose :: Int -> Get () Source #

Switch back to normal decoding {-# NOINLINE consClose #-}

consBool :: ConsState -> (ConsState, Bool) Source #

Decode a single bit

consBits :: ConsState -> Int -> (ConsState, Word) Source #

Decode from 1 to 3 bits

It could read more bits that are available, but it doesn't matter, errors will be checked in consClose.

NotEnoughSpace Env
TooMuchSpace Env
BadEncoding Env String
BadOp String