Error.Diagnose.Report

Re-exports

data Note msg

A note is a piece of information that is found at the end of a report.

Constructors

Note msg

A note, which is meant to give valuable information related to the encountered error.

Hint msg

A hint, to propose potential fixes or help towards fixing the issue.

Instances

Foldable Note

Defined in Error.Diagnose.Report.Internal

Methods

fold :: Monoid m => Note m -> m

foldMap :: Monoid m => (a -> m) -> Note a -> m

foldMap' :: Monoid m => (a -> m) -> Note a -> m

foldr :: (a -> b -> b) -> b -> Note a -> b

foldr' :: (a -> b -> b) -> b -> Note a -> b

foldl :: (b -> a -> b) -> b -> Note a -> b

foldl' :: (b -> a -> b) -> b -> Note a -> b

foldr1 :: (a -> a -> a) -> Note a -> a

foldl1 :: (a -> a -> a) -> Note a -> a

toList :: Note a -> [a]

null :: Note a -> Bool

length :: Note a -> Int

elem :: Eq a => a -> Note a -> Bool

maximum :: Ord a => Note a -> a

minimum :: Ord a => Note a -> a

sum :: Num a => Note a -> a

product :: Num a => Note a -> a

Traversable Note

Defined in Error.Diagnose.Report.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Note a -> f (Note b)

sequenceA :: Applicative f => Note (f a) -> f (Note a)

mapM :: Monad m => (a -> m b) -> Note a -> m (Note b)

sequence :: Monad m => Note (m a) -> m (Note a)

Functor Note

Defined in Error.Diagnose.Report.Internal

Methods

fmap :: (a -> b) -> Note a -> Note b

(<$) :: a -> Note b -> Note a

ToJSON msg => ToJSON (Note msg)

Defined in Error.Diagnose.Report.Internal

Methods

toJSON :: Note msg -> Value

toEncoding :: Note msg -> Encoding

toJSONList :: [Note msg] -> Value

toEncodingList :: [Note msg] -> Encoding

omitField :: Note msg -> Bool

IsString msg => IsString (Note msg)

Constructs a Note from the given message as a literal string.

Defined in Error.Diagnose.Report.Internal

Methods

fromString :: String -> Note msg

Show msg => Show (Note msg)

Defined in Error.Diagnose.Report.Internal

Methods

showsPrec :: Int -> Note msg -> ShowS

show :: Note msg -> String

showList :: [Note msg] -> ShowS

Eq msg => Eq (Note msg)

Defined in Error.Diagnose.Report.Internal

Methods

(==) :: Note msg -> Note msg -> Bool

(/=) :: Note msg -> Note msg -> Bool

Ord msg => Ord (Note msg)

Defined in Error.Diagnose.Report.Internal

Methods

compare :: Note msg -> Note msg -> Ordering

(<) :: Note msg -> Note msg -> Bool

(<=) :: Note msg -> Note msg -> Bool

(>) :: Note msg -> Note msg -> Bool

(>=) :: Note msg -> Note msg -> Bool

max :: Note msg -> Note msg -> Note msg

min :: Note msg -> Note msg -> Note msg

data Marker msg

The type of markers with abstract message type, shown under code lines.

Constructors

This msg

A red or yellow marker under source code, marking important parts of the code.

Where msg

A blue marker symbolizing additional information.

Maybe msg

A magenta marker to report potential fixes.

Blank

An empty marker, whose sole purpose is to include a line of code in the report without markers under.

Instances

Foldable Marker

Defined in Error.Diagnose.Report.Internal

Methods

fold :: Monoid m => Marker m -> m

foldMap :: Monoid m => (a -> m) -> Marker a -> m

foldMap' :: Monoid m => (a -> m) -> Marker a -> m

foldr :: (a -> b -> b) -> b -> Marker a -> b

foldr' :: (a -> b -> b) -> b -> Marker a -> b

foldl :: (b -> a -> b) -> b -> Marker a -> b

foldl' :: (b -> a -> b) -> b -> Marker a -> b

foldr1 :: (a -> a -> a) -> Marker a -> a

foldl1 :: (a -> a -> a) -> Marker a -> a

toList :: Marker a -> [a]

null :: Marker a -> Bool

length :: Marker a -> Int

elem :: Eq a => a -> Marker a -> Bool

maximum :: Ord a => Marker a -> a

minimum :: Ord a => Marker a -> a

sum :: Num a => Marker a -> a

product :: Num a => Marker a -> a

Traversable Marker

Defined in Error.Diagnose.Report.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Marker a -> f (Marker b)

sequenceA :: Applicative f => Marker (f a) -> f (Marker a)

mapM :: Monad m => (a -> m b) -> Marker a -> m (Marker b)

sequence :: Monad m => Marker (m a) -> m (Marker a)

Functor Marker

Defined in Error.Diagnose.Report.Internal

Methods

fmap :: (a -> b) -> Marker a -> Marker b

(<$) :: a -> Marker b -> Marker a

Eq msg => Eq (Marker msg)

Defined in Error.Diagnose.Report.Internal

Methods

(==) :: Marker msg -> Marker msg -> Bool

(/=) :: Marker msg -> Marker msg -> Bool

Ord msg => Ord (Marker msg)

Defined in Error.Diagnose.Report.Internal

Methods

compare :: Marker msg -> Marker msg -> Ordering

(<) :: Marker msg -> Marker msg -> Bool

(<=) :: Marker msg -> Marker msg -> Bool

(>) :: Marker msg -> Marker msg -> Bool

(>=) :: Marker msg -> Marker msg -> Bool

max :: Marker msg -> Marker msg -> Marker msg

min :: Marker msg -> Marker msg -> Marker msg

data Report msg where

The type of diagnostic reports with abstract message type.

Bundled Patterns

pattern Warn :: Maybe msg -> msg -> [(Position, Marker msg)] -> [Note msg] -> Report msg

Pattern synonym for a warning report.

pattern Err :: Maybe msg -> msg -> [(Position, Marker msg)] -> [Note msg] -> Report msg

Pattern synonym for an error report.

Instances

Foldable Report

Defined in Error.Diagnose.Report.Internal

Methods

fold :: Monoid m => Report m -> m

foldMap :: Monoid m => (a -> m) -> Report a -> m

foldMap' :: Monoid m => (a -> m) -> Report a -> m

foldr :: (a -> b -> b) -> b -> Report a -> b

foldr' :: (a -> b -> b) -> b -> Report a -> b

foldl :: (b -> a -> b) -> b -> Report a -> b

foldl' :: (b -> a -> b) -> b -> Report a -> b

foldr1 :: (a -> a -> a) -> Report a -> a

foldl1 :: (a -> a -> a) -> Report a -> a

toList :: Report a -> [a]

null :: Report a -> Bool

length :: Report a -> Int

elem :: Eq a => a -> Report a -> Bool

maximum :: Ord a => Report a -> a

minimum :: Ord a => Report a -> a

sum :: Num a => Report a -> a

product :: Num a => Report a -> a

Traversable Report

Defined in Error.Diagnose.Report.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Report a -> f (Report b)

sequenceA :: Applicative f => Report (f a) -> f (Report a)

mapM :: Monad m => (a -> m b) -> Report a -> m (Report b)

sequence :: Monad m => Report (m a) -> m (Report a)

Functor Report

Defined in Error.Diagnose.Report.Internal

Methods

fmap :: (a -> b) -> Report a -> Report b

(<$) :: a -> Report b -> Report a

ToJSON msg => ToJSON (Report msg)

Defined in Error.Diagnose.Report.Internal

Methods

toJSON :: Report msg -> Value

toEncoding :: Report msg -> Encoding

toJSONList :: [Report msg] -> Value

toEncodingList :: [Report msg] -> Encoding

omitField :: Report msg -> Bool

Monoid msg => Monoid (Report msg)

Defined in Error.Diagnose.Report.Internal

Methods

mempty :: Report msg

mappend :: Report msg -> Report msg -> Report msg

mconcat :: [Report msg] -> Report msg

Semigroup msg => Semigroup (Report msg)

Defined in Error.Diagnose.Report.Internal

Methods

(<>) :: Report msg -> Report msg -> Report msg

sconcat :: NonEmpty (Report msg) -> Report msg

stimes :: Integral b => b -> Report msg -> Report msg

warn

Arguments

:: Maybe msg

An optional error code to be shown right next to "error" or "warning".

-> msg

The report message, shown at the very top.

-> [(Position, Marker msg)]

A list associating positions with markers.

-> [Note msg]

A possibly mempty list of hints to add at the end of the report.

-> Report msg

Deprecated: warn is deprecated. Use Warn instead.

Constructs a warning or an error report.

err

Arguments

:: Maybe msg

An optional error code to be shown right next to "error" or "warning".

-> msg

The report message, shown at the very top.

-> [(Position, Marker msg)]

A list associating positions with markers.

-> [Note msg]

A possibly mempty list of hints to add at the end of the report.

-> Report msg

Deprecated: err is deprecated. Use Err instead.

Constructs a warning or an error report.

warningToError :: Report msg -> Report msg

Transforms a warning report into an error report.

errorToWarning :: Report msg -> Report msg

Transforms an error report into a warning report.