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


-- | Parsing framework based on conduit.
--   
--   The <tt>conduit-extra</tt> package provides utilities to turn a
--   <a>Parser</a> into a <a>Consumer</a>, but only for streams of
--   <a>ByteString</a>s of <a>Text</a>s (cf
--   <tt>Data.Conduit.Attoparsec</tt> module).
--   
--   This library makes it possible to work with any kind of input by
--   providing a general-purpose parsing framework based on <a>conduit</a>.
@package conduit-parse
@version 0.1.0.0


-- | This module introduces <a>ConduitParser</a>, a wrapper around
--   <a>Sink</a> that behaves like a parser.
--   
--   You probably want to import the <a>Text.Parser.Combinators</a> module
--   together with this module.
module Data.Conduit.Parser

-- | Core type of the package. This is basically a <a>Sink</a> with a
--   parsing state.
data ConduitParser i m a

-- | Run a <a>ConduitParser</a>. Any parsing failure will be thrown as an
--   exception.
runConduitParser :: (MonadThrow m) => ConduitParser i m a -> Sink i m a

-- | Flipped version of <tt>(&lt;?&gt;)</tt>.
named :: (MonadCatch m) => Text -> ConduitParser i m a -> ConduitParser i m a

-- | <a>await</a> wrapped as a <a>ConduitParser</a>.
--   
--   If no data is available, <a>UnexpectedEndOfInput</a> is thrown.
await :: (MonadCatch m) => ConduitParser i m i

-- | <a>leftover</a> wrapped as a <a>ConduitParser</a>.
leftover :: (Monad m) => i -> ConduitParser i m ()

-- | Return the name of the parser (assigned through <tt>(&lt;?&gt;)</tt>),
--   or <a>mempty</a> if has none.
getParserName :: ConduitParser i m Text

-- | <a>peek</a> wrapped as a <a>ConduitParser</a>.
peek :: (Monad m) => ConduitParser i m (Maybe i)
data ConduitParserException
BothFailed :: ConduitParserException -> ConduitParserException -> ConduitParserException
ExpectedEndOfInput :: ConduitParserException
NamedParserException :: Text -> ConduitParserException -> ConduitParserException
UnexpectedEndOfInput :: ConduitParserException
UnexpectedFollowedBy :: Text -> ConduitParserException
Unexpected :: Text -> ConduitParserException
instance GHC.Base.Applicative (Data.Conduit.Parser.ConduitParser i m)
instance GHC.Base.Functor (Data.Conduit.Parser.ConduitParser i m)
instance GHC.Base.Monad m => GHC.Base.Monad (Data.Conduit.Parser.ConduitParser i m)
instance GHC.Classes.Eq Data.Conduit.Parser.ConduitParserException
instance Control.Monad.Catch.MonadCatch m => GHC.Base.Alternative (Data.Conduit.Parser.ConduitParser i m)
instance Control.Monad.Catch.MonadThrow m => Control.Monad.Catch.MonadThrow (Data.Conduit.Parser.ConduitParser i m)
instance Control.Monad.Catch.MonadCatch m => Control.Monad.Catch.MonadCatch (Data.Conduit.Parser.ConduitParser i m)
instance Control.Monad.Trans.Class.MonadTrans (Data.Conduit.Parser.ConduitParser i)
instance Control.Monad.Catch.MonadCatch m => Text.Parser.Combinators.Parsing (Data.Conduit.Parser.ConduitParser i m)
instance GHC.Show.Show Data.Conduit.Parser.ConduitParserException
instance GHC.Exception.Exception Data.Conduit.Parser.ConduitParserException