polyparse Source code Contents Index

Text.ParserCombinators.Poly.ByteString

Contents The Parser datatype basic parsers re-parsing Re-export all more general combinators

Synopsis

newtype Parser a = P (ByteString -> Result ByteString a) data Result z a = Success z a | Failure z String | Committed (Result z a) runParser :: Parser a -> ByteString -> (Either String a, ByteString) next :: Parser Char eof :: Parser () satisfy :: (Char -> Bool) -> Parser Char reparse :: ByteString -> Parser () module Text.ParserCombinators.Poly.Base

The Parser datatype

newtype Parser a Source

This Parser datatype is a fairly generic parsing monad with error reporting. It can be used for arbitrary token types, not just String input. (If you require a running state, use module PolyState instead) Constructors P (ByteString -> Result ByteString a) Instances Monad Parser Functor Parser PolyParse Parser

data Result z a Source

A return type like Either, that distinguishes not only between right and wrong answers, but also has commitment, so that a failure cannot be undone. This should only be used for writing very primitive parsers - really it is an internal detail of the library. Constructors Success z a Failure z String Committed (Result z a) Instances Functor (Result z)

runParser :: Parser a -> ByteString -> (Either String a, ByteString) Source

Apply a parser to an input token sequence.

basic parsers

next :: Parser Char Source

eof :: Parser () Source

satisfy :: (Char -> Bool) -> Parser Char Source

re-parsing

reparse :: ByteString -> Parser () Source

Push some tokens back onto the front of the input stream and reparse. This is useful e.g. for recursively expanding macros. When the user-parser recognises a macro use, it can lookup the macro expansion from the parse state, lex it, and then stuff the lexed expansion back down into the parser.

Re-export all more general combinators

module Text.ParserCombinators.Poly.Base

Produced by Haddock version 2.4.2