Data.Binary.Strict.IncrementalGet

This is a version of the Get monad for incremental parsing. The parser is written as if a single, huge, strict ByteString was to be parsed. It produces results as it parses by calling yield.

However, if the parser runs out of data, rather than failing the caller sees a Partial result, which includes the list of yielded values so far and a continuation. By calling the continuation with more data, the parser continues, none the wiser.

Take the following example

testParse = do
  a <- getWord16be
  b <- getWord16be
  return $ a + b

test = runGet testParse $ B.pack [1,0,0]

Here testParse needs to read 4 bytes in order to complete, so test is a Partial, which includes the continuation function, so which you can pass more data until it completes

The lookahead functions have been removed from this parser because of their incompatibility with the incremental monad at the moment.

The Get type

data Get r a

Instances

Monad (Get r)

Defined in Data.Binary.Strict.IncrementalGet

Methods

(>>=) :: Get r a -> (a -> Get r b) -> Get r b

(>>) :: Get r a -> Get r b -> Get r b

return :: a -> Get r a

fail :: String -> Get r a

Functor (Get r)

Defined in Data.Binary.Strict.IncrementalGet

Methods

fmap :: (a -> b) -> Get r a -> Get r b

(<$) :: a -> Get r b -> Get r a

Applicative (Get r)

Defined in Data.Binary.Strict.IncrementalGet

Methods

pure :: a -> Get r a

(<*>) :: Get r (a -> b) -> Get r a -> Get r b

liftA2 :: (a -> b -> c) -> Get r a -> Get r b -> Get r c

(*>) :: Get r a -> Get r b -> Get r b

(<*) :: Get r a -> Get r b -> Get r a

Alternative (Get r)

Defined in Data.Binary.Strict.IncrementalGet

Methods

empty :: Get r a

(<|>) :: Get r a -> Get r a -> Get r a

some :: Get r a -> Get r [a]

many :: Get r a -> Get r [a]

MonadPlus (Get r)

Defined in Data.Binary.Strict.IncrementalGet

Methods

mzero :: Get r a

mplus :: Get r a -> Get r a -> Get r a

BinaryParser (Get r)

Defined in Data.Binary.Strict.IncrementalGet

Methods

skip :: Int -> Get r ()

bytesRead :: Get r Int

remaining :: Get r Int

isEmpty :: Get r Bool

spanOf :: (Word8 -> Bool) -> Get r ByteString

spanOf1 :: (Word8 -> Bool) -> Get r ByteString

string :: ByteString -> Get r ()

word8 :: Word8 -> Get r ()

oneOf :: (Word8 -> Bool) -> Get r Word8

many :: Get r a -> Get r [a]

many1 :: Get r a -> Get r [a]

optional :: Get r a -> Get r (Maybe a)

getWord8 :: Get r Word8

getByteString :: Int -> Get r ByteString

getWord16be :: Get r Word16

getWord32be :: Get r Word32

getWord64be :: Get r Word64

getWord16le :: Get r Word16

getWord32le :: Get r Word32

getWord64le :: Get r Word64

getWordhost :: Get r Word

getWord16host :: Get r Word16

getWord32host :: Get r Word32

getWord64host :: Get r Word64

data Result a

The result of a partial parse

Constructors

Failed String

the parse failed with the given error message

Finished ByteString a

the parse finished and produced the given list of results doing so. Any unparsed data is returned.

Partial (ByteString -> Result a)

the parse ran out of data before finishing, but produced the given list of results before doing so. To continue the parse pass more data to the given continuation

Instances

Show a => Show (Result a)

Defined in Data.Binary.Strict.IncrementalGet

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

runGet :: Get r r -> ByteString -> Result r

Start a parser and return the first Result.

Utility

skip :: Int -> Get r ()

Skip ahead n bytes. Fails if fewer than n bytes are available.

bytesRead :: Get r Int

Get the total number of bytes read to this point.

remaining :: Get r Int

Get the number of remaining unparsed bytes. Useful for checking whether all input has been consumed.

isEmpty :: Get r Bool

Test whether all input has been consumed, i.e. there are no remaining unparsed bytes.

plus :: Get r a -> Get r a -> Get r a

This is the choice operator. If the first option fails, the second is tried. The failure of the first option must happen within this function otherwise rollback is not attempted.

zero :: Get r a

spanOf :: (Word8 -> Bool) -> Get r ByteString

suspend :: Get r ()

Yield a partial and get more data

Parsing particular types

getWord8 :: Get r Word8

ByteStrings

getByteString :: Int -> Get r ByteString

An efficient get method for strict ByteStrings. Fails if fewer than n bytes are left in the input.

Big-endian reads

getWord16be :: Get r Word16

getWord32be :: Get r Word32

getWord64be :: Get r Word64

Little-endian reads

getWord16le :: Get r Word16

getWord32le :: Get r Word32

getWord64le :: Get r Word64

Host-endian, unaligned reads

getWordhost :: Get r Word

getWord16host :: Get r Word16

getWord32host :: Get r Word32

getWord64host :: Get r Word64