Data.Conduit.Parser

This module introduces ConduitParser, a wrapper around Sink that behaves like a parser.

You probably want to import the Text.Parser.Combinators module together with this module.

Conduit parser monad

data ConduitParser i m a

Core type of the package. This is basically a Sink with a parsing state.

Instances

MonadError ConduitParserException (ConduitParser i m)

Backtracking is supported by pushing back consumed elements (using leftover) whenever an error is catched.

As a consequence, within the scope of a catchError, all streamed items are kept in memory, which means the consumer no longer uses constant memory.

MonadTrans (ConduitParser i)

Monad (ConduitParser i m)

Functor (ConduitParser i m)

Applicative (ConduitParser i m)

Alternative (ConduitParser i m)

Parsers can be combined with (<|>), some, many, optional, choice.

The use of guard is not recommended as it generates unhelpful error messages. Please consider using throwError or unexpected instead.

MonadThrow m => MonadThrow (ConduitParser i m)

MonadCatch m => MonadCatch (ConduitParser i m)

MonadIO m => MonadIO (ConduitParser i m)

Monad m => Parsing (ConduitParser i m)

Parsing combinators can be used with ConduitParsers.

runConduitParser :: MonadThrow m => ConduitParser i m a -> Sink i m a

Run a ConduitParser. Any parsing failure will be thrown as an exception.

named :: Monad m => Text -> ConduitParser i m a -> ConduitParser i m a

Flipped version of (<?>).

Primitives

await :: Monad m => ConduitParser i m i

await wrapped as a ConduitParser.

If no data is available, UnexpectedEndOfInput is thrown.

leftover :: i -> ConduitParser i m ()

leftover wrapped as a ConduitParser.

getParserName :: ConduitParser i m Text

Return the name of the parser (assigned through (<?>)), or mempty if has none.

Utility

peek :: Monad m => ConduitParser i m (Maybe i)

peek wrapped as a ConduitParser.

Exception

data ConduitParserException

Constructors

BothFailed ConduitParserException ConduitParserException

ExpectedEndOfInput

NamedParserException Text ConduitParserException

UnexpectedEndOfInput

UnexpectedFollowedBy Text

Unexpected Text

Instances

Eq ConduitParserException

Show ConduitParserException

Exception ConduitParserException

MonadError ConduitParserException (ConduitParser i m)

Backtracking is supported by pushing back consumed elements (using leftover) whenever an error is catched.

As a consequence, within the scope of a catchError, all streamed items are kept in memory, which means the consumer no longer uses constant memory.