Moduleconduit-parse-0.2.1.1Haskell2010

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.

Contents

Synopsis

Conduit parser monad

newtypenewtype ConduitParser i (m :: Type -> Type) a

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

Instances9MonadError, MonadTrans, Monad, Functor, Applicative, Alternative, …

MonadError ConduitParserException (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
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)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Monad (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Functor (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Applicative (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Alternative (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
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.
MonadIO m => MonadIO (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
MonadThrow m => MonadThrow (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Monad m => Parsing (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Parsing combinators can be used with ConduitParsers.

valuerunConduitParser

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

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

Flipped version of (<?>).

valueawait :: Monad m => ConduitParser i m i

If no data is available, UnexpectedEndOfInput is thrown.

valueleftover :: i -> ConduitParser i m ()

valuegetParserNames :: ConduitParser i m [Text]

Return the ordered list of names (assigned through (<?>)) for the current parser stack. First element is the most nested parser.

valuegetParserName :: ConduitParser i m Text

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

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

datadata ConduitParserException

Instances4Eq, Show, Exception, MonadError

Eq ConduitParserExceptionDefined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Show ConduitParserExceptionDefined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
Exception ConduitParserExceptionDefined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
MonadError ConduitParserException (ConduitParser i m)Defined in conduit-parse-0.2.1.1 · Data.Conduit.Parser.Internal
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.