Config.Schema.Load.Error

This module provides a complete skeleton of the failures that occurred when trying to match a Value against a ValueSpec allowing custom error rendering to be implemented.

The structure is you get a single value and a list of one-or-more primitive specifications that it failed to match along with an enumeration of why that specification failed to match. Some failures are due to failures in nested specifications, so the whole error structure can form a tree.

Error types

data ValueSpecMismatch p

Newtype wrapper for schema load errors.

Since: 1.2.0.0

Constructors

ValueSpecMismatch p Text (NonEmpty (PrimMismatch p))

Problem value and list of specification failures

Instances

Show p => Show (ValueSpecMismatch p)

Defined in Config.Schema.Load.Error

Methods

showsPrec :: Int -> ValueSpecMismatch p -> ShowS

show :: ValueSpecMismatch p -> String

showList :: [ValueSpecMismatch p] -> ShowS

ErrorAnnotation p => Exception (ValueSpecMismatch p)

displayException implemented with prettyValueSpecMismatch and simplifyValueSpecMismatch.

Since: 1.2.0.0

Defined in Config.Schema.Load.Error

Methods

toException :: ValueSpecMismatch p -> SomeException

fromException :: SomeException -> Maybe (ValueSpecMismatch p)

displayException :: ValueSpecMismatch p -> String

data PrimMismatch p

Type for errors that can be encountered while decoding a value according to a specification. The error includes a key path indicating where in the configuration file the error occurred.

Since: 1.2.0.0

Constructors

PrimMismatch Text (Problem p)

spec description and problem

Instances

Show p => Show (PrimMismatch p)

Defined in Config.Schema.Load.Error

Methods

showsPrec :: Int -> PrimMismatch p -> ShowS

show :: PrimMismatch p -> String

showList :: [PrimMismatch p] -> ShowS

data Problem p

Problems that can be encountered when matching a Value against a ValueSpec.

Since: 1.2.0.0

Constructors

MissingSection Text

missing section name

UnusedSections (NonEmpty Text)

unused section names

SubkeyProblem Text (ValueSpecMismatch p)

nested error in given section

ListElementProblem Int (ValueSpecMismatch p)

nested error in given list element

NestedProblem (ValueSpecMismatch p)

generic nested error

TypeMismatch

value and spec type mismatch

CustomProblem Text

custom spec error message

WrongAtom

atoms didn't match

Instances

Show p => Show (Problem p)

Defined in Config.Schema.Load.Error

Methods

showsPrec :: Int -> Problem p -> ShowS

show :: Problem p -> String

showList :: [Problem p] -> ShowS

class (Typeable a, Show a) => ErrorAnnotation a where

Class for rendering position annotations within the prettyValueSpecMismatch

Since: 1.2.0.0

Methods

displayAnnotation :: a -> Doc

Instances

ErrorAnnotation ()

Renders as an empty document

Since: 1.2.0.0

Defined in Config.Schema.Load.Error

Methods

displayAnnotation :: () -> Doc

ErrorAnnotation FilePosition

Defined in Config.Schema.Load.Error

Methods

displayAnnotation :: FilePosition -> Doc

ErrorAnnotation Position

Renders a Position as line:column:

Since: 1.2.0.0

Defined in Config.Schema.Load.Error

Methods

displayAnnotation :: Position -> Doc

Detailed rendering

prettyValueSpecMismatch :: ErrorAnnotation p => ValueSpecMismatch p -> Doc

Pretty-printer for ValueSpecMismatch showing the position and type of value that failed to match along with details about each specification that it didn't match.

Since: 1.2.0.0

prettyPrimMismatch :: ErrorAnnotation p => PrimMismatch p -> Doc

Pretty-printer for PrimMismatch showing a summary of the primitive specification that didn't match followed by a more detailed error when appropriate.

Since: 1.2.0.0

prettyProblem

Arguments

:: ErrorAnnotation p

=> Problem p

-> (Doc, Doc)

summary, detailed

Pretty-printer for Problem that generates a summary line as well as a detailed description (depending on the error)

Since: 1.2.0.0

Summaries

describeSpec :: PrimValueSpec a -> Text

Describe outermost shape of a PrimValueSpec

Since: 1.2.0.0

describeValue :: Value p -> Text

Describe outermost shape of a Value

simplifyValueSpecMismatch :: ValueSpecMismatch p -> ValueSpecMismatch p

Simplify a ValueSpecMismatch by collapsing long nested error cases and by assuming that if a type matched that the other mismatched type alternatives are uninteresting. This is used in the implementation of displayException.

Since: 1.2.1.0