Data.API.Error

Representation of JSON parsing errors

data JSONError

Represents an error that can be encountered while parsing

Constructors

Expected Expected String Value

BadFormat FormatExpected String Text

MissingField

MissingAlt [String]

UnexpectedField

UnexpectedEnumVal [Text] Text

IntRangeError String Int IntRange

UTCRangeError String UTCTime UTCRange

RegexError String Text RegEx

SyntaxError String

Instances

Eq JSONError

Methods

(==) :: JSONError -> JSONError -> Bool

(/=) :: JSONError -> JSONError -> Bool

Show JSONError

Methods

showsPrec :: Int -> JSONError -> ShowS

show :: JSONError -> String

showList :: [JSONError] -> ShowS

ToJSON JSONError

Methods

toJSON :: JSONError -> Value

toEncoding :: JSONError -> Encoding

toJSONList :: [JSONError] -> Value

toEncodingList :: [JSONError] -> Encoding

FromJSON JSONError

Methods

parseJSON :: Value -> Parser JSONError

parseJSONList :: Value -> Parser [JSONError]

type JSONWarning = JSONError

At present, we do not distinguish between errors and warnings

data Expected

JSON type expected at a particular position, when a value of a different type was encountered

Constructors

ExpArray

ExpBool

ExpInt

ExpObject

ExpString

Instances

Eq Expected

Methods

(==) :: Expected -> Expected -> Bool

(/=) :: Expected -> Expected -> Bool

Show Expected

Methods

showsPrec :: Int -> Expected -> ShowS

show :: Expected -> String

showList :: [Expected] -> ShowS

ToJSON Expected

Methods

toJSON :: Expected -> Value

toEncoding :: Expected -> Encoding

toJSONList :: [Expected] -> Value

toEncodingList :: [Expected] -> Encoding

FromJSON Expected

Methods

parseJSON :: Value -> Parser Expected

parseJSONList :: Value -> Parser [Expected]

data FormatExpected

Special format expected of a string

Constructors

FmtBinary

FmtUTC

FmtOther

Instances

Eq FormatExpected

Methods

(==) :: FormatExpected -> FormatExpected -> Bool

(/=) :: FormatExpected -> FormatExpected -> Bool

Show FormatExpected

Methods

showsPrec :: Int -> FormatExpected -> ShowS

show :: FormatExpected -> String

showList :: [FormatExpected] -> ShowS

ToJSON FormatExpected

Methods

toJSON :: FormatExpected -> Value

toEncoding :: FormatExpected -> Encoding

toJSONList :: [FormatExpected] -> Value

toEncodingList :: [FormatExpected] -> Encoding

FromJSON FormatExpected

Methods

parseJSON :: Value -> Parser FormatExpected

parseJSONList :: Value -> Parser [FormatExpected]

type Position = [Step]

A position inside a JSON value is a list of steps, ordered innermost first (so going inside an object prepends a step).

data Step

Each step may be into a field of an object, or a specific element of an array.

Constructors

InField Text

InElem Int

Instances

Eq Step

Methods

(==) :: Step -> Step -> Bool

(/=) :: Step -> Step -> Bool

Show Step

Methods

showsPrec :: Int -> Step -> ShowS

show :: Step -> String

showList :: [Step] -> ShowS

ToJSON Step

Methods

toJSON :: Step -> Value

toEncoding :: Step -> Encoding

toJSONList :: [Step] -> Value

toEncodingList :: [Step] -> Encoding

FromJSON Step

Methods

parseJSON :: Value -> Parser Step

parseJSONList :: Value -> Parser [Step]

SafeCopy Step

Methods

version :: Version Step

kind :: Kind Step

getCopy :: Contained (Get Step)

putCopy :: Step -> Contained Put

internalConsistency :: Consistency Step

objectProfile :: Profile Step

errorTypeName :: Proxy Step -> String

PPLines Step

Methods

ppLines :: Step -> [String]

inField :: FieldName -> Step

prettyJSONErrorPositions :: [(JSONError, Position)] -> String

Human-readable presentation of a list of parse errors with their positions

prettyJSONError :: JSONError -> String

Human-readable description of a JSON parse error

prettyStep :: Step -> String

Human-readable description of a single step in a position

JSON parse error construction

expectedArray :: Value -> JSONError

expectedBool :: Value -> JSONError

expectedInt :: Value -> JSONError

expectedObject :: Value -> JSONError

expectedString :: Value -> JSONError

badFormat :: String -> Text -> JSONError

Validation and migration errors

data ValueError

Errors that can be discovered when migrating data values

Constructors

JSONError JSONError

Data doesn't match schema

CustomMigrationError String Value

Error generated during custom migration

InvalidAPI ApplyFailure

An API change was invalid

Instances

Eq ValueError

Methods

(==) :: ValueError -> ValueError -> Bool

(/=) :: ValueError -> ValueError -> Bool

Show ValueError

Methods

showsPrec :: Int -> ValueError -> ShowS

show :: ValueError -> String

showList :: [ValueError] -> ShowS

PPLines ValueError

Methods

ppLines :: ValueError -> [String]

data ValidateFailure

Errors that may be discovered when validating a changelog

Constructors

ChangelogOutOfOrder

the changelog must be in descending order of versions

Fields

• vfLaterVersion :: VersionExtra
• vfEarlierVersion :: VersionExtra

CannotDowngrade

forbid migrating from one version to an earlier version

Fields

• vfFromVersion :: VersionExtra
• vfToVersion :: VersionExtra

ApiInvalid

an API uses types that are not declared

Fields

• vfInvalidVersion :: VersionExtra
• vfMissingDeclarations :: Set TypeName

ChangelogEntryInvalid

changelog entry does not apply

Fields

• vfSuccessfullyApplied :: [APITableChange]
• vfFailedToApply :: APIChange
• vfApplyFailure :: ApplyFailure

ChangelogIncomplete

changelog is incomplete (ie all entries apply ok but result isn't the target api)

Fields

• vfChangelogVersion :: VersionExtra
• vfTargetVersion :: VersionExtra
• vfDifferences :: Map TypeName (MergeResult NormTypeDecl NormTypeDecl)

Instances

Eq ValidateFailure

Methods

(==) :: ValidateFailure -> ValidateFailure -> Bool

(/=) :: ValidateFailure -> ValidateFailure -> Bool

Show ValidateFailure

Methods

showsPrec :: Int -> ValidateFailure -> ShowS

show :: ValidateFailure -> String

showList :: [ValidateFailure] -> ShowS

PPLines ValidateFailure

Methods

ppLines :: ValidateFailure -> [String]

data ValidateWarning

Instances

Show ValidateWarning

Methods

showsPrec :: Int -> ValidateWarning -> ShowS

show :: ValidateWarning -> String

showList :: [ValidateWarning] -> ShowS

data ApplyFailure

Errors that may occur applying a single API change

Constructors

TypeExists

for adding or renaming type

Fields

• afExistingType :: TypeName

TypeDoesNotExist

for deleting or renaming a type

Fields

• afMissingType :: TypeName

TypeWrongKind

e.g. it's not a record type

Fields

• afTypeName :: TypeName
• afExpectedKind :: TypeKind

TypeInUse

cannot delete/modify types that are still used

Fields

• afTypeName :: TypeName

TypeMalformed

type refers to a non-existent type

Fields

• afType :: APIType
• afMissingTypes :: Set TypeName

DeclMalformed

decl refers to a non-existent type

Fields

• afTypeName :: TypeName
• afDecl :: NormTypeDecl
• afMissingTypes :: Set TypeName

FieldExists

for adding or renaming a field

Fields

• afTypeName :: TypeName
• afTypeKind :: TypeKind
• afExistingField :: FieldName

FieldDoesNotExist

for deleting or renaming a field

Fields

• afTypeName :: TypeName
• afTypeKind :: TypeKind
• afMissingField :: FieldName

FieldBadDefaultValue

for adding a field, must be a default value compatible with the type

Fields

• afTypeName :: TypeName
• afFieldName :: FieldName
• afFieldType :: APIType
• afBadDefault :: DefaultValue

DefaultMissing

for adding a field to a table

Fields

• afTypeName :: TypeName
• afFieldName :: FieldName

TableChangeError

custom error in tableChange

Fields

• afCustomMessage :: String

Instances

Eq ApplyFailure

Methods

(==) :: ApplyFailure -> ApplyFailure -> Bool

(/=) :: ApplyFailure -> ApplyFailure -> Bool

Show ApplyFailure

Methods

showsPrec :: Int -> ApplyFailure -> ShowS

show :: ApplyFailure -> String

showList :: [ApplyFailure] -> ShowS

PPLines ApplyFailure

Methods

ppLines :: ApplyFailure -> [String]

data TypeKind

Constructors

TKRecord

TKUnion

TKEnum

TKNewtype

TKTypeSynonym

Instances

Eq TypeKind

Methods

(==) :: TypeKind -> TypeKind -> Bool

(/=) :: TypeKind -> TypeKind -> Bool

Show TypeKind

Methods

showsPrec :: Int -> TypeKind -> ShowS

show :: TypeKind -> String

showList :: [TypeKind] -> ShowS

PP TypeKind

Methods

pp :: TypeKind -> String

data MigrateFailure

Constructors

ValidateFailure ValidateFailure

ValueError ValueError Position

Instances

Eq MigrateFailure

Methods

(==) :: MigrateFailure -> MigrateFailure -> Bool

(/=) :: MigrateFailure -> MigrateFailure -> Bool

Show MigrateFailure

Methods

showsPrec :: Int -> MigrateFailure -> ShowS

show :: MigrateFailure -> String

showList :: [MigrateFailure] -> ShowS

PPLines MigrateFailure

Methods

ppLines :: MigrateFailure -> [String]

type MigrateWarning = ValidateWarning

prettyMigrateFailure :: MigrateFailure -> String

prettyValidateFailure :: ValidateFailure -> String

prettyValueError :: ValueError -> String

prettyValueErrorPosition :: (ValueError, Position) -> String