Error.Diagnose.Report

Re-exports

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.

Instances

Eq (Marker msg)

Defined in Error.Diagnose.Report.Internal

Methods

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

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

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

The type of diagnostic reports with abstract message type.

Instances

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

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

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

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.

-> [msg]

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

-> Report msg

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.

-> [msg]

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

-> Report msg

Constructs a warning or an error report.