Text.Megaparsec.Error.Builder

A set of helpers that should make construction of ParseErrors more concise. This is primarily useful in test suites and for debugging.

Since: 6.0.0

Top-level helpers

err

Arguments

:: Int

ParseError offset

-> ET s

Error components

-> ParseError s e

Resulting ParseError

Assemble a ParseError from offset and ET t value. ET t is a monoid and can be assembled by combining primitives provided by this module, see below.

errFancy

Arguments

:: Int

ParseError offset

-> EF e

Error components

-> ParseError s e

Resulting ParseError

Like err, but constructs a “fancy” ParseError.

Error components

utok :: Stream s => Token s -> ET s

Construct an “unexpected token” error component.

utoks :: forall s. Stream s => Tokens s -> ET s

Construct an “unexpected tokens” error component. Empty chunk produces EndOfInput.

ulabel :: Stream s => String -> ET s

Construct an “unexpected label” error component. Do not use with empty strings (for empty strings it's bottom).

ueof :: Stream s => ET s

Construct an “unexpected end of input” error component.

etok :: Stream s => Token s -> ET s

Construct an “expected token” error component.

etoks :: forall s. Stream s => Tokens s -> ET s

Construct an “expected tokens” error component. Empty chunk produces EndOfInput.

elabel :: Stream s => String -> ET s

Construct an “expected label” error component. Do not use with empty strings.

eeof :: Stream s => ET s

Construct an “expected end of input” error component.

fancy :: ErrorFancy e -> EF e

Construct a custom error component.

Data types

data ET s

Auxiliary type for construction of trivial parse errors.

Instances

Eq (Token s) => Eq (ET s)

Defined in Text.Megaparsec.Error.Builder

Methods

(==) :: ET s -> ET s -> Bool

(/=) :: ET s -> ET s -> Bool

(Data s, Data (Token s), Ord (Token s)) => Data (ET s)

Defined in Text.Megaparsec.Error.Builder

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ET s -> c (ET s)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (ET s)

toConstr :: ET s -> Constr

dataTypeOf :: ET s -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (ET s))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (ET s))

gmapT :: (forall b. Data b => b -> b) -> ET s -> ET s

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ET s -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ET s -> r

gmapQ :: (forall d. Data d => d -> u) -> ET s -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ET s -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ET s -> m (ET s)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ET s -> m (ET s)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ET s -> m (ET s)

Ord (Token s) => Ord (ET s)

Defined in Text.Megaparsec.Error.Builder

Methods

compare :: ET s -> ET s -> Ordering

(<) :: ET s -> ET s -> Bool

(<=) :: ET s -> ET s -> Bool

(>) :: ET s -> ET s -> Bool

(>=) :: ET s -> ET s -> Bool

max :: ET s -> ET s -> ET s

min :: ET s -> ET s -> ET s

Generic (ET s)

Defined in Text.Megaparsec.Error.Builder

Associated Types

type Rep (ET s) :: Type -> Type

Methods

from :: ET s -> Rep (ET s) x

to :: Rep (ET s) x -> ET s

Stream s => Semigroup (ET s)

Defined in Text.Megaparsec.Error.Builder

Methods

(<>) :: ET s -> ET s -> ET s

sconcat :: NonEmpty (ET s) -> ET s

stimes :: Integral b => b -> ET s -> ET s

Stream s => Monoid (ET s)

Defined in Text.Megaparsec.Error.Builder

Methods

mempty :: ET s

mappend :: ET s -> ET s -> ET s

mconcat :: [ET s] -> ET s

type Rep (ET s)

Defined in Text.Megaparsec.Error.Builder

type Rep (ET s) = D1 (MetaData "ET" "Text.Megaparsec.Error.Builder" "megaparsec-7.0.3-33us1Wj7Xo51sKKEffQvN7" False) (C1 (MetaCons "ET" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (ErrorItem (Token s)))) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set (ErrorItem (Token s))))))

data EF e

Auxiliary type for construction of fancy parse errors.

Instances

Eq e => Eq (EF e)

Defined in Text.Megaparsec.Error.Builder

Methods

(==) :: EF e -> EF e -> Bool

(/=) :: EF e -> EF e -> Bool

(Data e, Ord e) => Data (EF e)

Defined in Text.Megaparsec.Error.Builder

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EF e -> c (EF e)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (EF e)

toConstr :: EF e -> Constr

dataTypeOf :: EF e -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (EF e))

dataCast2 :: Typeable t => (forall d e0. (Data d, Data e0) => c (t d e0)) -> Maybe (c (EF e))

gmapT :: (forall b. Data b => b -> b) -> EF e -> EF e

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EF e -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EF e -> r

gmapQ :: (forall d. Data d => d -> u) -> EF e -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> EF e -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EF e -> m (EF e)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EF e -> m (EF e)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EF e -> m (EF e)

Ord e => Ord (EF e)

Defined in Text.Megaparsec.Error.Builder

Methods

compare :: EF e -> EF e -> Ordering

(<) :: EF e -> EF e -> Bool

(<=) :: EF e -> EF e -> Bool

(>) :: EF e -> EF e -> Bool

(>=) :: EF e -> EF e -> Bool

max :: EF e -> EF e -> EF e

min :: EF e -> EF e -> EF e

Generic (EF e)

Defined in Text.Megaparsec.Error.Builder

Associated Types

type Rep (EF e) :: Type -> Type

Methods

from :: EF e -> Rep (EF e) x

to :: Rep (EF e) x -> EF e

Ord e => Semigroup (EF e)

Defined in Text.Megaparsec.Error.Builder

Methods

(<>) :: EF e -> EF e -> EF e

sconcat :: NonEmpty (EF e) -> EF e

stimes :: Integral b => b -> EF e -> EF e

Ord e => Monoid (EF e)

Defined in Text.Megaparsec.Error.Builder

Methods

mempty :: EF e

mappend :: EF e -> EF e -> EF e

mconcat :: [EF e] -> EF e

type Rep (EF e)

Defined in Text.Megaparsec.Error.Builder

type Rep (EF e) = D1 (MetaData "EF" "Text.Megaparsec.Error.Builder" "megaparsec-7.0.3-33us1Wj7Xo51sKKEffQvN7" True) (C1 (MetaCons "EF" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set (ErrorFancy e)))))