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


-- | An alternate with typed errors for Data.Binary.Get monad from 'binary' library.
--   
--   An alternate with typed errors for Data.Binary.Get monad from
--   <a>binary</a> library.
@package binary-ext
@version 1.0

module Data.Binary.Get.Ext.Internal
data Get e a
runCont :: Get e a -> forall r. Int64 -> ByteString -> Success e a r -> Decoder e r

-- | A decoder produced by running a <a>Get</a> monad.
data Decoder e a

-- | The decoder ran into an error. The decoder either used <a>fail</a> or
--   was not provided enough input.
Fail :: !ByteString -> (Either String e) -> Decoder e a

-- | The decoder has consumed the available input and needs more to
--   continue. Provide <a>Just</a> if more input is available and
--   <a>Nothing</a> otherwise, and you will get a new <a>Decoder</a>.
Partial :: (Maybe ByteString -> Decoder e a) -> Decoder e a

-- | The decoder has successfully finished. Except for the output value you
--   also get the unused input.
Done :: !ByteString -> a -> Decoder e a

-- | The decoder needs to know the current position in the input. Given the
--   number of bytes remaning in the decoder, the outer decoder runner
--   needs to calculate the position and resume the decoding.
BytesRead :: {-# UNPACK #-} !Int64 -> (Int64 -> Decoder e a) -> Decoder e a

-- | Run a <a>Get</a> monad. See <a>Decoder</a> for what to do next, like
--   providing input, handling decoding errors and to get the output value.
runGetIncremental :: Int64 -> Get e a -> Decoder e a

-- | Return at least <tt>n</tt> bytes, maybe more. If not enough data is
--   available the computation will escape with <a>Partial</a>.
readN :: Int -> (ByteString -> a) -> Get () a

-- | <tt>readNWith n f</tt> where <tt>f</tt> must be deterministic and not
--   have side effects.
readNWith :: Int -> (Ptr a -> IO a) -> Get () a

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

-- | Get e the total number of bytes read to this point.
totalBytesRead :: Get e Int64

-- | Isolate a decoder to operate with a fixed number of bytes, and fail if
--   fewer bytes were consumed, or more bytes were attempted to be
--   consumed. If the given decoder fails, <a>isolate</a> will also fail.
--   Offset from <a>bytesRead</a> will be relative to the start of
--   <a>isolate</a>, not the absolute of the input.
isolate :: Int -> Get e a -> (Int -> e) -> Get e a
withInputChunks :: s -> Consume s -> ([ByteString] -> b) -> ([ByteString] -> Get e b) -> Get e b
type Consume s = s -> ByteString -> Either s (ByteString, ByteString)
failOnEOF :: [ByteString] -> Get () a

-- | Get e the current chunk.
get :: Get e ByteString

-- | Replace the current chunk.
put :: ByteString -> Get e ()

-- | Ensure that there are at least <tt>n</tt> bytes available. If not, the
--   computation will escape with <a>Partial</a>.
ensureN :: Int -> Get () ()

-- | Test whether all input has been consumed, i.e. there are no remaining
--   undecoded bytes.
isEmpty :: Get e Bool
failG :: e -> Get e a

-- | Run the given decoder, but without consuming its input. If the given
--   decoder fails, then so will this function.
--   
--   <i>Since: 0.7.0.0</i>
lookAhead :: Get e a -> Get e a

-- | Run the given decoder, and only consume its input if it returns
--   <a>Just</a>. If <a>Nothing</a> is returned, the input will be
--   unconsumed. If the given decoder fails, then so will this function.
--   
--   <i>Since: 0.7.0.0</i>
lookAheadM :: Get e (Maybe a) -> Get e (Maybe a)

-- | Run the given decoder, and only consume its input if it returns
--   <a>Right</a>. If <a>Left</a> is returned, the input will be
--   unconsumed. If the given decoder fails, then so will this function.
lookAheadE :: Get e (Either a b) -> Get e (Either a b)
label :: String -> Get String a -> Get String a

-- | Convert decoder error. If the decoder fails, the given function will
--   be applied to the error message.
onError :: (e -> e') -> Get e a -> Get e' a

-- | Set decoder error. If the decoder fails, the given error will be used
--   as the error message.
withError :: Get () a -> e -> Get e a

-- | An efficient get method for strict ByteStrings. Fails if fewer than
--   <tt>n</tt> bytes are left in the input. If <tt>n &lt;= 0</tt> then the
--   empty string is returned.
getByteString :: Int -> Get () ByteString
instance GHC.Base.Monad (Data.Binary.Get.Ext.Internal.Get e)
instance Control.Monad.Fail.MonadFail (Data.Binary.Get.Ext.Internal.Get e)
instance GHC.Base.Applicative (Data.Binary.Get.Ext.Internal.Get e)
instance GHC.Base.MonadPlus (Data.Binary.Get.Ext.Internal.Get e)
instance GHC.Base.Functor (Data.Binary.Get.Ext.Internal.Get e)
instance GHC.Base.Functor (Data.Binary.Get.Ext.Internal.Decoder e)
instance (GHC.Show.Show e, GHC.Show.Show a) => GHC.Show.Show (Data.Binary.Get.Ext.Internal.Decoder e a)
instance GHC.Base.Alternative (Data.Binary.Get.Ext.Internal.Get e)

module Data.Binary.Get.Ext
data Get e a

-- | Run a <a>Get</a> monad and return <a>Left</a> on failure and
--   <a>Right</a> on success. In both cases any unconsumed input and the
--   number of bytes consumed is returned. In the case of failure, a
--   human-readable error message is included as well.
runGetOrFail :: ByteOffset -> Get e a -> ByteString -> Either (ByteString, ByteOffset, Either String e) (ByteString, ByteOffset, a)

-- | An offset, counted in bytes.
type ByteOffset = Int64

-- | A decoder procuced by running a <a>Get</a> monad.
data Decoder e a

-- | The decoder ran into an error. The decoder either used <a>fail</a> or
--   was not provided enough input. Contains any unconsumed input and the
--   number of bytes consumed.
Fail :: !ByteString -> {-# UNPACK #-} !ByteOffset -> (Either String e) -> Decoder e a

-- | The decoder has consumed the available input and needs more to
--   continue. Provide <a>Just</a> if more input is available and
--   <a>Nothing</a> otherwise, and you will get a new <a>Decoder</a>.
Partial :: (Maybe ByteString -> Decoder e a) -> Decoder e a

-- | The decoder has successfully finished. Except for the output value you
--   also get any unused input as well as the number of bytes consumed.
Done :: !ByteString -> {-# UNPACK #-} !ByteOffset -> a -> Decoder e a

-- | Run a <a>Get</a> monad. See <a>Decoder</a> for what to do next, like
--   providing input, handling decoder errors and to get the output value.
--   Hint: Use the helper functions <a>pushChunk</a>, <a>pushChunks</a> and
--   <a>pushEndOfInput</a>.
runGetIncremental :: ByteOffset -> Get e a -> Decoder e a

-- | Feed a <a>Decoder</a> with more input. If the <a>Decoder</a> is
--   <a>Done</a> or <a>Fail</a> it will add the input to <a>ByteString</a>
--   of unconsumed input.
--   
--   <pre>
--   <a>runGetIncremental</a> myParser `pushChunk` myInput1 `pushChunk` myInput2
--   </pre>
pushChunk :: Decoder e a -> ByteString -> Decoder e a

-- | Feed a <a>Decoder</a> with more input. If the <a>Decoder</a> is
--   <a>Done</a> or <a>Fail</a> it will add the input to
--   <tt>ByteString</tt> of unconsumed input.
--   
--   <pre>
--   <a>runGetIncremental</a> myParser `pushChunks` myLazyByteString
--   </pre>
pushChunks :: Decoder e a -> ByteString -> Decoder e a

-- | Tell a <a>Decoder</a> that there is no more input. This passes
--   <a>Nothing</a> to a <a>Partial</a> decoder, otherwise returns the
--   decoder unchanged.
pushEndOfInput :: Decoder e a -> Decoder e a

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

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

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

-- | Get e the total number of bytes read to this point.
totalBytesRead :: Get e Int64

-- | Isolate a decoder to operate with a fixed number of bytes, and fail if
--   fewer bytes were consumed, or more bytes were attempted to be
--   consumed. If the given decoder fails, <a>isolate</a> will also fail.
--   Offset from <a>bytesRead</a> will be relative to the start of
--   <a>isolate</a>, not the absolute of the input.
isolate :: Int -> Get e a -> (Int -> e) -> Get e a

-- | Run the given decoder, but without consuming its input. If the given
--   decoder fails, then so will this function.
--   
--   <i>Since: 0.7.0.0</i>
lookAhead :: Get e a -> Get e a

-- | Run the given decoder, and only consume its input if it returns
--   <a>Just</a>. If <a>Nothing</a> is returned, the input will be
--   unconsumed. If the given decoder fails, then so will this function.
--   
--   <i>Since: 0.7.0.0</i>
lookAheadM :: Get e (Maybe a) -> Get e (Maybe a)

-- | Run the given decoder, and only consume its input if it returns
--   <a>Right</a>. If <a>Left</a> is returned, the input will be
--   unconsumed. If the given decoder fails, then so will this function.
lookAheadE :: Get e (Either a b) -> Get e (Either a b)
label :: String -> Get String a -> Get String a

-- | Convert decoder error. If the decoder fails, the given function will
--   be applied to the error message.
onError :: (e -> e') -> Get e a -> Get e' a

-- | Set decoder error. If the decoder fails, the given error will be used
--   as the error message.
withError :: Get () a -> e -> Get e a
failG :: e -> Get e a

-- | An efficient get method for strict ByteStrings. Fails if fewer than
--   <tt>n</tt> bytes are left in the input. If <tt>n &lt;= 0</tt> then the
--   empty string is returned.
getByteString :: Int -> Get () ByteString

-- | An efficient get method for lazy ByteStrings. Fails if fewer than
--   <tt>n</tt> bytes are left in the input.
getLazyByteString :: Int64 -> Get () ByteString

-- | Get a lazy ByteString that is terminated with a NUL byte. The returned
--   string does not contain the NUL byte. Fails if it reaches the end of
--   input without finding a NUL.
getLazyByteStringNul :: Get () ByteString

-- | Get the remaining bytes as a lazy ByteString. Note that this can be an
--   expensive function to use as it forces reading all input and keeping
--   the string in-memory.
getRemainingLazyByteString :: Get e ByteString

-- | Read a Word8 from the monad state
getWord8 :: Get () Word8

-- | 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

-- | Read an Int8 from the monad state
getInt8 :: Get () Int8

-- | Read an Int16 in big endian format.
getInt16be :: Get () Int16

-- | Read an Int32 in big endian format.
getInt32be :: Get () Int32

-- | Read an Int64 in big endian format.
getInt64be :: Get () Int64

-- | Read an Int16 in little endian format.
getInt16le :: Get () Int16

-- | Read an Int32 in little endian format.
getInt32le :: Get () Int32

-- | Read an Int64 in little endian format.
getInt64le :: Get () Int64

-- | <i>O(1).</i> Read a single native machine word in native host order.
--   It works in the same way as <a>getWordhost</a>.
getInthost :: Get () Int

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

-- | <i>O(1).</i> Read an Int32 in native host order and host endianness.
getInt32host :: Get () Int32

-- | <i>O(1).</i> Read an Int64 in native host order and host endianess.
getInt64host :: Get () Int64

-- | Read a <a>Float</a> in big endian IEEE-754 format.
getFloatbe :: Get () Float

-- | Read a <a>Float</a> in little endian IEEE-754 format.
getFloatle :: Get () Float

-- | Read a <a>Float</a> in IEEE-754 format and host endian.
getFloathost :: Get () Float

-- | Read a <a>Double</a> in big endian IEEE-754 format.
getDoublebe :: Get () Double

-- | Read a <a>Double</a> in little endian IEEE-754 format.
getDoublele :: Get () Double

-- | Read a <a>Double</a> in IEEE-754 format and host endian.
getDoublehost :: Get () Double