Safe Haskell	Safe-Inferred
Language	Haskell2010

FlatParse.Basic.Parser

Contents

Parser
Result
- Internal
Choice operator (defined with right associativity)

Description

Minimal parser definition.

Synopsis

newtype ParserT (st :: ZeroBitType) e a = ParserT {
- runParserT# :: ForeignPtrContents -> Addr# -> Addr# -> st -> Res# st e a
}
type Parser = ParserT PureMode
type ParserIO = ParserT IOMode
type ParserST s = ParserT (STMode s)
type Res# (st :: ZeroBitType) e a = (# st, ResI# e a #)
pattern OK# :: (st :: ZeroBitType) -> a -> Addr# -> Res# st e a
pattern Err# :: (st :: ZeroBitType) -> e -> Res# st e a
pattern Fail# :: (st :: ZeroBitType) -> Res# st e a
type ResI# e a = (# (# a, Addr# #) | (# #) | (# e #) #)
(<|>) :: ParserT st e a -> ParserT st e a -> ParserT st e a

Parser

newtype ParserT (st :: ZeroBitType) e a Source #

ParserT st e a is a parser with a state token type st, an error type e and a return type a. The different state token types support different embedded effects; see Parser, ParserIO and ParserST below.

Constructors

ParserT
Fields runParserT# :: ForeignPtrContents -> Addr# -> Addr# -> st -> Res# st e a

Instances

Instances details

MonadIO (ParserIO e) Source #	You may lift IO actions into a `ParserIO` using `liftIO`.
Instance details Defined in FlatParse.Basic.Parser Methods liftIO :: IO a -> ParserIO e a #
Alternative (ParserT st e) Source #	By default, parser choice `(<\|>)` arbitrarily backtracks on parser failure.
Instance details Defined in FlatParse.Basic.Parser Methods empty :: ParserT st e a # (<\|>) :: ParserT st e a -> ParserT st e a -> ParserT st e a # some :: ParserT st e a -> ParserT st e [a] # many :: ParserT st e a -> ParserT st e [a] #
Applicative (ParserT st e) Source #
Instance details Defined in FlatParse.Basic.Parser Methods pure :: a -> ParserT st e a # (<>) :: ParserT st e (a -> b) -> ParserT st e a -> ParserT st e b # liftA2 :: (a -> b -> c) -> ParserT st e a -> ParserT st e b -> ParserT st e c # (>) :: ParserT st e a -> ParserT st e b -> ParserT st e b # (<*) :: ParserT st e a -> ParserT st e b -> ParserT st e a #
Functor (ParserT st e) Source #
Instance details Defined in FlatParse.Basic.Parser Methods fmap :: (a -> b) -> ParserT st e a -> ParserT st e b # (<$) :: a -> ParserT st e b -> ParserT st e a #
Monad (ParserT st e) Source #
Instance details Defined in FlatParse.Basic.Parser Methods (>>=) :: ParserT st e a -> (a -> ParserT st e b) -> ParserT st e b # (>>) :: ParserT st e a -> ParserT st e b -> ParserT st e b # return :: a -> ParserT st e a #
MonadPlus (ParserT st e) Source #
Instance details Defined in FlatParse.Basic.Parser Methods mzero :: ParserT st e a # mplus :: ParserT st e a -> ParserT st e a -> ParserT st e a #

type Parser = ParserT PureMode Source #

The type of pure parsers.

type ParserIO = ParserT IOMode Source #

The type of parsers which can embed IO actions.

type ParserST s = ParserT (STMode s) Source #

The type of parsers which can embed ST actions.

Result

type Res# (st :: ZeroBitType) e a = (# st, ResI# e a #) Source #

Primitive parser result wrapped with a state token.

You should rarely need to manipulate values of this type directly. Use the provided bidirectional pattern synonyms OK#, Fail# and Err#.

pattern OK# :: (st :: ZeroBitType) -> a -> Addr# -> Res# st e a Source #

Res# constructor for a successful parse. Contains the return value and a pointer to the rest of the input buffer, plus a state token.

pattern Err# :: (st :: ZeroBitType) -> e -> Res# st e a Source #

Res# constructor for errors which are by default non-recoverable. Contains the error, plus a state token.

pattern Fail# :: (st :: ZeroBitType) -> Res# st e a Source #

Res# constructor for recoverable failure. Contains only a state token.

Internal

type ResI# e a = (# (# a, Addr# #) | (# #) | (# e #) #) Source #

Primitive parser result.

Choice operator (defined with right associativity)

(<|>) :: ParserT st e a -> ParserT st e a -> ParserT st e a infixr 6 Source #

Choose between two parsers. If the first parser fails, try the second one, but if the first one throws an error, propagate the error. This operation can arbitrarily backtrack.

Note: this exported operator has different fixity than the same operator in Applicative. Hide this operator if you want to use the Alternative version.