Text.Parsing.StringParser

type Pos = Int

A position in an input string.

type PosString = { pos :: Pos, str :: String }

Strings are represented as a string with an index from the start of the string.

{ str: s, pos: n } is interpreted as the substring of s starting at index n.

This allows us to avoid repeatedly finding substrings every time we match a character.

data ParseError

The type of parsing errors.

Constructors

• ParseError String

Instances

• Show ParseError
• Eq ParseError
• Ord ParseError

newtype Parser a

A parser is represented as a function which takes a pair of continuations for failure and success.

Constructors

• Parser (PosString -> Either { error :: ParseError, pos :: Pos } { result :: a, suffix :: PosString })

Instances

• Functor Parser
• Apply Parser
• Applicative Parser
• Alt Parser
• Plus Parser
• Alternative Parser
• Bind Parser
• Monad Parser
• MonadZero Parser
• MonadPlus Parser
• MonadRec Parser
• Lazy (Parser a)
• (Semigroup a) => Semigroup (Parser a)

unParser :: forall a. Parser a -> PosString -> Either { error :: ParseError, pos :: Pos } { result :: a, suffix :: PosString }

Run a parser by providing success and failure continuations.

runParser :: forall a. Parser a -> String -> Either ParseError a

Run a parser for an input string, returning either an error or a result.

fail :: forall a. String -> Parser a

Fail with the specified message.

try :: forall a. Parser a -> Parser a

In case of error, the default behavior is to backtrack if no input was consumed.

try p backtracks even if input was consumed.