Modulepipes-attoparsec-0.6.0Haskell2010

Pipes.Attoparsec

pipes utilities for incrementally running attoparsec-based parsers.

This module assumes familiarity with pipes-parse, you can learn about it in Pipes.Parse.Tutorial.

1 type
1 class
5 values

Packagepipes-attoparsec-0.6.0
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAttoparsec.hs

Parsing

2 declarations

valueparse

:: (Monad m, ParserInput a)
=> Parser a b
Attoparsec parser
-> Parser a m (Maybe (Either ParsingError b))
Pipes parser

Convert an attoparsec Parser to a pipes-parse Parser.

This Parser is compatible with the tools from Pipes.Parse.

It returns Nothing if the underlying Producer is exhausted, otherwise it attempts to run the given attoparsec Parser on the underlying Producer, possibly failing with ParsingError.

valueparsed

:: (Monad m, ParserInput a)
=> Parser a b
Attoparsec parser
-> Producer a m r
Raw input
-> Producer b m (Either (ParsingError, Producer a m r) r)

Convert a producer of ParserInput to a producer of parsed values.

This producer returns Right when end-of-input is reached successfully, otherwise it returns a ParsingError and the leftovers including the malformed input that couldn't be parsed. You can use Pipes.Lift.errorP to promote the Either return value to an Control.Monad.Trans.Error.ErrorT monad transformer.

Including input length

Like the functions above, but these also provide information about the length of input consumed in order to fully parse each value.

valueparseL

:: (Monad m, ParserInput a)
=> Parser a b
Attoparsec parser
-> Parser a m (Maybe (Either ParsingError (Int, b)))
Pipes parser

Like parse, but also returns the length of input consumed to parse the value.

valueparsedL

:: (Monad m, ParserInput a)
=> Parser a b
Attoparsec parser
-> Producer a m r
Raw input
-> Producer (Int, b) m (Either (ParsingError, Producer a m r) r)

Like parsed, except this tags each parsed value with the length of input consumed to parse the value.

Utils

1 declaration

valueisEndOfParserInput :: (Monad m, ParserInput a) => Parser a m Bool

Like isEndOfInput, except that it also consumes and discards leading empty chunks.

Types

2 declarations

classclass (Eq a, Monoid a) => ParserInput a where

A class for valid attoparsec input types

Instances2ParserInput

ParserInput ByteStringDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec
Strict ByteString.
ParserInput TextDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec
Strict Text.

datadata ParsingError

A parsing error report, as provided by Attoparsec's Fail.

Constructors

ParsingError
- peContexts :: [String]
  Contexts where the parsing error occurred.
- peMessage :: String
  Parsing error description message.

Instances5Eq, Data, Read, Show, Exception

Eq ParsingErrorDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec
Data ParsingErrorDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec
Read ParsingErrorDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec
Show ParsingErrorDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec
Exception ParsingErrorDefined in pipes-attoparsec-0.6.0 · Pipes.Attoparsec