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


-- | A simple unassuming parser for bytestring
--   
@package bsparse
@version 0.0.4


-- | A very simple bytestring parser related to Parsec and Attoparsec
--   
--   Simple example:
--   
--   <pre>
--   &gt; parse ((,) &lt;$&gt; take 2 &lt;*&gt; byte 0x20 &lt;*&gt; (bytes "abc" *&gt; anyByte)) "xx abctest"
--   ParseOK "est" ("xx", 116)
--   </pre>
module Data.ByteString.Parse

-- | Simple ByteString parser structure
data Parser a

-- | Simple parsing result, that represent respectively:
--   
--   <ul>
--   <li>failure: with the error message</li>
--   <li>continuation: that need for more input data</li>
--   <li>success: the remaining unparsed data and the parser value</li>
--   </ul>
data Result a
ParseFail :: String -> Result a
ParseMore :: (ByteString -> Result a) -> Result a
ParseOK :: ByteString -> a -> Result a

-- | Run a Parser on a ByteString and return a <a>Result</a>
parse :: Parser a -> ByteString -> Result a

-- | Run a parser on an @initial ByteString.
--   
--   If the Parser need more data than available, the @feeder function is
--   automatically called and fed to the More continuation.
parseFeed :: Monad m => m ByteString -> Parser a -> ByteString -> m (Result a)

-- | Parse a specific byte at current position
--   
--   if the byte is different than the expected on, this parser will raise
--   a failure.
byte :: Word8 -> Parser ()

-- | Get the next byte from the parser
anyByte :: Parser Word8

-- | Parse a sequence of bytes from current position
--   
--   if the following bytes don't match the expected bytestring completely,
--   the parser will raise a failure
bytes :: ByteString -> Parser ()

-- | Take @n bytes from the current position in the stream
take :: Int -> Parser ByteString

-- | Take bytes while the @predicate hold from the current position in the
--   stream
takeWhile :: (Word8 -> Bool) -> Parser ByteString

-- | Take the remaining bytes from the current position in the stream
takeAll :: Parser ByteString

-- | Skip @n bytes from the current position in the stream
skip :: Int -> Parser ()

-- | Skip bytes while the @predicate hold from the current position in the
--   stream
skipWhile :: (Word8 -> Bool) -> Parser ()

-- | Skip all the remaining bytes from the current position in the stream
skipAll :: Parser ()

-- | Take a storable from the current position in the stream
takeStorable :: Storable d => Parser d
instance Alternative Parser
instance Applicative Parser
instance Functor Parser
instance MonadPlus Parser
instance Monad Parser
instance Show a => Show (Result a)