-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Binary deserialisation using strict ByteStrings
--   
--   This is a strict version of the Get monad from the binary package.
--   Ti's pretty much just a copy and paste job from the original source
--   code. The binary team are currently unsure about their future plans
--   w.r.t. strictness, so this is just a stop gap measure.
@package binary-strict
@version 0.1


-- | This is a strict version of the Get monad from the binary package.
--   It's pretty much just a copy and paste job from the original source
--   code. The binary team are currently unsure about their future plans
--   w.r.t. strictness, so this is a stop gap measure.
--   
--   To use, write a function in the Get monad:
--   
--   <pre>
--   import Data.Binary.Strict.Get as BinStrict
--   import Data.ByteString as BS
--   parse :: BinStrict.Get
--   parse = getWord16be
--   main = print $ runGet parse $ BS.pack [1, 1]
--   </pre>
--   
--   This results in a tuple of (Right 257, "") (where the second element
--   is just the remaining data after the parser has run)
module Data.Binary.Strict.Get
data Get a

-- | Run a parser on the given input and return the result (either an error
--   string from a call to <tt>fail</tt>, or the parsing result) and the
--   remainder of of the input.
runGet :: Get a -> ByteString -> (Either String a, ByteString)

-- | Run <tt>ga</tt>, but return without consuming its input. Fails if
--   <tt>ga</tt> fails.
lookAhead :: Get a -> Get a

-- | Like <a>lookAhead</a>, but consume the input if <tt>gma</tt> returns
--   'Just _'. Fails if <tt>gma</tt> fails.
lookAheadM :: Get (Maybe a) -> Get (Maybe a)

-- | Like <a>lookAhead</a>, but consume the input if <tt>gea</tt> returns
--   'Right _'. Fails if <tt>gea</tt> fails.
lookAheadE :: Get (Either a b) -> Get (Either a b)

-- | Skip ahead <tt>n</tt> bytes. Fails if fewer than <tt>n</tt> bytes are
--   available.
skip :: Int -> Get ()

-- | Get the total number of bytes read to this point.
bytesRead :: Get Int

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

-- | Test whether all input has been consumed, i.e. there are no remaining
--   unparsed bytes.
isEmpty :: Get Bool
getWord8 :: Get Word8

-- | An efficient <a>get</a> method for strict ByteStrings. Fails if fewer
--   than <tt>n</tt> bytes are left in the input.
getByteString :: Int -> Get ByteString

-- | Read a Word16 in big endian format
getWord16be :: Get Word16

-- | Read a Word32 in big endian format
getWord32be :: Get Word32

-- | Read a Word64 in big endian format
getWord64be :: Get Word64

-- | Read a Word16 in little endian format
getWord16le :: Get Word16

-- | Read a Word32 in little endian format
getWord32le :: Get Word32

-- | Read a Word64 in little endian format
getWord64le :: Get Word64

-- | <i>O(1).</i> Read a single native machine word. The word is read in
--   host order, host endian form, for the machine you're on. On a 64 bit
--   machine the Word is an 8 byte value, on a 32 bit machine, 4 bytes.
getWordhost :: Get Word

-- | <i>O(1).</i> Read a 2 byte Word16 in native host order and host
--   endianness.
getWord16host :: Get Word16

-- | <i>O(1).</i> Read a Word32 in native host order and host endianness.
getWord32host :: Get Word32

-- | <i>O(1).</i> Read a Word64 in native host order and host endianess.
getWord64host :: Get Word64
instance Monad Get
instance Functor Get