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


-- | Binary utilities for the machines library
--   
--   Binary utilities for the machines library
@package machines-binary
@version 7.0.0.0

module Data.Binary.Machine

-- | Construct a Plan that run a <a>Get</a> until it fails or it return a
--   parsed result. This plan automatically manages the pushback of unused
--   input.
--   
--   You can use this function to construct a machine and run a <a>Get</a>
--   on the provided input. With <a>stack</a> you can convert the created
--   machine to a normal machine
--   
--   <pre>
--   -- construct the machine
--   myMachine :: <tt>Machine</tt> (<a>Stack</a> ByteString) (Either DecodingError Word8)
--   myMachine = <tt>construct</tt> $ <a>processGet</a> <tt>getWord8</tt>
--   
--   -- run the machine
--   run $ <a>stack</a> (<tt>source</tt> ["abc", "d", "efgh"]) myMachine
--   </pre>
--   
--   You can combine machines created in this way with the facilities
--   provided by the machines package.
--   
--   <pre>
--   --run m2 after m1
--   myMachine = m1 &lt;&gt; m2
--     where
--       m1 = construct $ processGet (getByteString 5)
--       m2 = construct $ processGet (getByteString 1)
--   
--   run $ stack (source ["abc", "d", "efgh"]) myMachine
--   &gt; [Right "abcde",Right "f"]
--   </pre>
processGet :: Get a -> Plan (Stack ByteString) (Either DecodingError a) ()

-- | Same as <a>processGet</a> with additional information about the number
--   of bytes consumed by the <a>Get</a>
processGetL :: Get a -> Plan (Stack ByteString) (Either DecodingError (ByteOffset, a)) ()

-- | Run a <a>Get</a> multiple times and stream its results
--   
--   <pre>
--   run $ source ["abc", "d", "efgh"] ~&gt; streamGet (getByteString 2)
--   &gt; [Right "ab",Right "cd",Right "ef",Right "gh"]
--   </pre>
streamGet :: Get a -> Process ByteString (Either DecodingError a)

-- | Same as <a>streamGet</a> with additional information about the number
--   of bytes consumed by the <a>Get</a>
streamGetL :: Get a -> Process ByteString (Either DecodingError (ByteOffset, a))

-- | Encode evrery input object with a <a>Put</a>
processPut :: Monad m => (a -> Put) -> ProcessT m a ByteString

-- | A <a>Get</a> decoding error.
data DecodingError
DecodingError :: {-# UNPACK #-} !ByteOffset -> !String -> DecodingError

-- | Number of bytes consumed before the error
[deConsumed] :: DecodingError -> {-# UNPACK #-} !ByteOffset

-- | Error message
[deMessage] :: DecodingError -> !String
instance GHC.Classes.Eq Data.Binary.Machine.DecodingError
instance GHC.Read.Read Data.Binary.Machine.DecodingError
instance GHC.Show.Show Data.Binary.Machine.DecodingError