Cabal-3.2.0.0: A framework for packaging Haskell software
Safe HaskellNone
LanguageHaskell2010

Distribution.Fields.ParseResult

Description

A parse result type for parsers from AST to Haskell types.

Synopsis

Documentation

data ParseResult a Source #

A monad with failure and accumulating errors and warnings.

Instances

Instances details
Monad ParseResult Source # 
Instance details

Defined in Distribution.Fields.ParseResult

Functor ParseResult Source # 
Instance details

Defined in Distribution.Fields.ParseResult

Methods

fmap :: (a -> b) -> ParseResult a -> ParseResult b Source #

(<$) :: a -> ParseResult b -> ParseResult a Source #

Applicative ParseResult Source # 
Instance details

Defined in Distribution.Fields.ParseResult

runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a) Source #

Destruct a ParseResult into the emitted warnings and either a successful value or list of errors and possibly recovered a spec-version declaration.

recoverWith :: ParseResult a -> a -> ParseResult a Source #

Recover the parse result, so we can proceed parsing. runParseResult will still result in Nothing, if there are recorded errors.

parseWarning :: Position -> PWarnType -> String -> ParseResult () Source #

Add a warning. This doesn't fail the parsing process.

parseWarnings :: [PWarning] -> ParseResult () Source #

Add multiple warnings at once.

parseFailure :: Position -> String -> ParseResult () Source #

Add an error, but not fail the parser yet.

For fatal failure use parseFatalFailure

parseFatalFailure :: Position -> String -> ParseResult a Source #

Add an fatal error.

getCabalSpecVersion :: ParseResult (Maybe Version) Source #

Get cabal spec version.

setCabalSpecVersion :: Maybe Version -> ParseResult () Source #

Set cabal spec version.

readAndParseFile Source #

Arguments

:: (ByteString -> ParseResult a)

File contents to final value parser

-> Verbosity

Verbosity level

-> FilePath

File to read

-> IO a 

Helper combinator to do parsing plumbing for files.

Given a parser and a filename, return the parse of the file, after checking if the file exists.

Argument order is chosen to encourage partial application.

parseString Source #

Arguments

:: (ByteString -> ParseResult a)

File contents to final value parser

-> Verbosity

Verbosity level

-> String

File name

-> ByteString 
-> IO a