Safe Haskell	None
Language	Haskell2010

Data.Conduit.Parser

Contents

Conduit parser monad
Primitives
Utility
Exception
Utilities

Description

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.

Synopsis

Conduit parser monad

newtype ConduitParser i m a #

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

Constructors

ConduitParser (ExceptT ConduitParserException (StateT ([Text], Buffer i) (Sink i m)) a)

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.
Methods throwError :: ConduitParserException -> ConduitParser i m a # catchError :: ConduitParser i m a -> (ConduitParserException -> ConduitParser i m a) -> ConduitParser i m a #
MonadTrans (ConduitParser i) #
Methods lift :: Monad m => m a -> ConduitParser i m a #
Monad (ConduitParser i m) #
Methods (>>=) :: ConduitParser i m a -> (a -> ConduitParser i m b) -> ConduitParser i m b # (>>) :: ConduitParser i m a -> ConduitParser i m b -> ConduitParser i m b # return :: a -> ConduitParser i m a # fail :: String -> ConduitParser i m a #
Functor (ConduitParser i m) #
Methods fmap :: (a -> b) -> ConduitParser i m a -> ConduitParser i m b # (<$) :: a -> ConduitParser i m b -> ConduitParser i m a #
Applicative (ConduitParser i m) #
Methods pure :: a -> ConduitParser i m a # (<>) :: ConduitParser i m (a -> b) -> ConduitParser i m a -> ConduitParser i m b # (>) :: ConduitParser i m a -> ConduitParser i m b -> ConduitParser i m b # (<*) :: ConduitParser i m a -> ConduitParser i m b -> ConduitParser i m a #
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.
Methods empty :: ConduitParser i m a # (<\|>) :: ConduitParser i m a -> ConduitParser i m a -> ConduitParser i m a # some :: ConduitParser i m a -> ConduitParser i m [a] # many :: ConduitParser i m a -> ConduitParser i m [a] #
MonadIO m => MonadIO (ConduitParser i m) #
Methods liftIO :: IO a -> ConduitParser i m a #
MonadThrow m => MonadThrow (ConduitParser i m) #
Methods throwM :: Exception e => e -> ConduitParser i m a #
MonadCatch m => MonadCatch (ConduitParser i m) #
Methods catch :: Exception e => ConduitParser i m a -> (e -> ConduitParser i m a) -> ConduitParser i m a #
Monad m => CharParsing (ConduitParser Char m) #
Methods satisfy :: (Char -> Bool) -> ConduitParser Char m Char # char :: Char -> ConduitParser Char m Char # notChar :: Char -> ConduitParser Char m Char # anyChar :: ConduitParser Char m Char # string :: String -> ConduitParser Char m String # text :: Text -> ConduitParser Char m Text #
Monad m => Parsing (ConduitParser i m) #	Parsing combinators can be used with `ConduitParser`s.
Methods try :: ConduitParser i m a -> ConduitParser i m a # (<?>) :: ConduitParser i m a -> String -> ConduitParser i m a # skipMany :: ConduitParser i m a -> ConduitParser i m () # skipSome :: ConduitParser i m a -> ConduitParser i m () # unexpected :: String -> ConduitParser i m a # eof :: ConduitParser i m () # notFollowedBy :: Show a => ConduitParser i m a -> ConduitParser i m () #

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.

anyOne :: Monad m => ConduitParser i m i #

Synonym for await

leftover :: i -> ConduitParser i m () #

leftover wrapped as a ConduitParser.

getParserNames :: ConduitParser i m [Text] #

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

getParserName :: ConduitParser i m Text #

Return the name (assigned through (<?>)) of the current parser (most nested), or mempty if it 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 #
Methods (==) :: ConduitParserException -> ConduitParserException -> Bool # (/=) :: ConduitParserException -> ConduitParserException -> Bool #
Show ConduitParserException #
Methods showsPrec :: Int -> ConduitParserException -> ShowS # show :: ConduitParserException -> String # showList :: [ConduitParserException] -> ShowS #
Exception ConduitParserException #
Methods toException :: ConduitParserException -> SomeException # fromException :: SomeException -> Maybe ConduitParserException # displayException :: ConduitParserException -> String #
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.
Methods throwError :: ConduitParserException -> ConduitParser i m a # catchError :: ConduitParser i m a -> (ConduitParserException -> ConduitParser i m a) -> ConduitParser i m a #

Utilities

parseC :: MonadThrow m => ConduitParser i m a -> Conduit i m a #

Turn a parser into a regular Conduit that yields parsed items as long as the parser succeeds. Once the parser fails, the conduit stops consuming input and won't yield any more.

parseOrSkipC :: MonadThrow m => ConduitParser i m a -> ConduitParser i m b -> Conduit i m a #

lastRequired :: MonadThrow m => Text -> Consumer a m a #

lastDef :: MonadThrow m => a -> Consumer a m a #

embed :: MonadCatch m => Sink i m a -> ConduitParser i m a #