Safe Haskell	Safe-Inferred
Language	Haskell2010

Bookhound.Parser

Synopsis

data Parser a
data ParseResult a
- = Result Input a
- | Error ParseError
data ParseError
- = UnexpectedEof
- | ExpectedEof Input
- | ErrorAt Text
mkParser :: (Input -> ParseResult a) -> Parser a
runParser :: Parser a -> Input -> Either [ParseError] a
throwError :: MonadError e m => e -> m a
andThen :: Parser Text -> Parser a -> Parser a
exactly :: Parser a -> Parser a
eof :: Parser ()
lookAhead :: Parser a -> Parser a
notFollowedBy :: Parser a -> Parser ()
both :: Parser a -> Parser a -> Parser a
choice :: Foldable f => f (Parser a) -> Parser a
anyOf :: Foldable f => f (Parser a) -> Parser a
allOf :: Foldable f => f (Parser a) -> Parser a
anyChar :: Parser Char
satisfy :: (a -> Bool) -> Parser a -> Parser a
withTransform :: (forall b. Parser b -> Parser b) -> Parser a -> Parser a
withError :: Text -> Parser a -> Parser a
withErrorN :: Int -> Text -> Parser a -> Parser a
except :: Parser a -> Parser a -> Parser a

Documentation

data Parser a Source #

Instances

Instances details

Alternative Parser Source #
Instance details Defined in Bookhound.Parser Methods empty :: Parser a # (<\|>) :: Parser a -> Parser a -> Parser a # some :: Parser a -> Parser [a] # many :: Parser a -> Parser [a] #
Applicative Parser Source #
Instance details Defined in Bookhound.Parser Methods pure :: a -> Parser a # (<>) :: Parser (a -> b) -> Parser a -> Parser b # liftA2 :: (a -> b -> c) -> Parser a -> Parser b -> Parser c # (>) :: Parser a -> Parser b -> Parser b # (<*) :: Parser a -> Parser b -> Parser a #
Functor Parser Source #
Instance details Defined in Bookhound.Parser Methods fmap :: (a -> b) -> Parser a -> Parser b # (<$) :: a -> Parser b -> Parser a #
Monad Parser Source #
Instance details Defined in Bookhound.Parser Methods (>>=) :: Parser a -> (a -> Parser b) -> Parser b # (>>) :: Parser a -> Parser b -> Parser b # return :: a -> Parser a #
MonadPlus Parser Source #
Instance details Defined in Bookhound.Parser Methods mzero :: Parser a # mplus :: Parser a -> Parser a -> Parser a #
MonadError ParseError Parser Source #
Instance details Defined in Bookhound.Parser Methods throwError :: ParseError -> Parser a # catchError :: Parser a -> (ParseError -> Parser a) -> Parser a #
Monoid a => Monoid (Parser a) Source #
Instance details Defined in Bookhound.Parser Methods mempty :: Parser a # mappend :: Parser a -> Parser a -> Parser a # mconcat :: [Parser a] -> Parser a #
Semigroup a => Semigroup (Parser a) Source #
Instance details Defined in Bookhound.Parser Methods (<>) :: Parser a -> Parser a -> Parser a # sconcat :: NonEmpty (Parser a) -> Parser a # stimes :: Integral b => b -> Parser a -> Parser a #

data ParseResult a Source #

Constructors

Result Input a
Error ParseError

Instances

Instances details

Functor ParseResult Source #
Instance details Defined in Bookhound.Parser Methods fmap :: (a -> b) -> ParseResult a -> ParseResult b # (<$) :: a -> ParseResult b -> ParseResult a #
Show a => Show (ParseResult a) Source #
Instance details Defined in Bookhound.Parser Methods showsPrec :: Int -> ParseResult a -> ShowS # show :: ParseResult a -> String # showList :: [ParseResult a] -> ShowS #
Eq a => Eq (ParseResult a) Source #
Instance details Defined in Bookhound.Parser Methods (==) :: ParseResult a -> ParseResult a -> Bool # (/=) :: ParseResult a -> ParseResult a -> Bool #

data ParseError Source #

Constructors

UnexpectedEof
ExpectedEof Input
ErrorAt Text

Instances

Instances details

Show ParseError Source #
Instance details Defined in Bookhound.Parser Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS #
Eq ParseError Source #
Instance details Defined in Bookhound.Parser Methods (==) :: ParseError -> ParseError -> Bool # (/=) :: ParseError -> ParseError -> Bool #
Ord ParseError Source #
Instance details Defined in Bookhound.Parser Methods compare :: ParseError -> ParseError -> Ordering # (<) :: ParseError -> ParseError -> Bool # (<=) :: ParseError -> ParseError -> Bool # (>) :: ParseError -> ParseError -> Bool # (>=) :: ParseError -> ParseError -> Bool # max :: ParseError -> ParseError -> ParseError # min :: ParseError -> ParseError -> ParseError #
MonadError ParseError Parser Source #
Instance details Defined in Bookhound.Parser Methods throwError :: ParseError -> Parser a # catchError :: Parser a -> (ParseError -> Parser a) -> Parser a #

mkParser :: (Input -> ParseResult a) -> Parser a Source #

runParser :: Parser a -> Input -> Either [ParseError] a Source #

throwError :: MonadError e m => e -> m a #

Is used within a monadic computation to begin exception processing.

andThen :: Parser Text -> Parser a -> Parser a Source #

exactly :: Parser a -> Parser a Source #

eof :: Parser () Source #

lookAhead :: Parser a -> Parser a Source #

notFollowedBy :: Parser a -> Parser () Source #

both :: Parser a -> Parser a -> Parser a Source #

choice :: Foldable f => f (Parser a) -> Parser a Source #

anyOf :: Foldable f => f (Parser a) -> Parser a Source #

allOf :: Foldable f => f (Parser a) -> Parser a Source #

anyChar :: Parser Char Source #

satisfy :: (a -> Bool) -> Parser a -> Parser a Source #

withTransform :: (forall b. Parser b -> Parser b) -> Parser a -> Parser a Source #

withError :: Text -> Parser a -> Parser a Source #

withErrorN :: Int -> Text -> Parser a -> Parser a Source #

except :: Parser a -> Parser a -> Parser a Source #