Safe Haskell	None
Language	Haskell2010

Data.API.Error

Contents

Representation of JSON parsing errors
JSON parse error construction
Validation and migration errors

Synopsis

data JSONError
- = 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
type JSONWarning = JSONError
data Expected
- = ExpArray
- | ExpBool
- | ExpInt
- | ExpObject
- | ExpString
data FormatExpected
- = FmtBinary
- | FmtUTC
- | FmtOther
type Position = [Step]
data Step
- = InField Text
- | InElem Int
inField :: FieldName -> Step
prettyJSONErrorPositions :: [(JSONError, Position)] -> String
prettyJSONError :: JSONError -> String
prettyStep :: Step -> String
expectedArray :: Value -> JSONError
expectedBool :: Value -> JSONError
expectedInt :: Value -> JSONError
expectedObject :: Value -> JSONError
expectedString :: Value -> JSONError
badFormat :: String -> Text -> JSONError
data ValueError
- = JSONError JSONError
- | CustomMigrationError String Value
- | InvalidAPI ApplyFailure
data ValidateFailure
- = ChangelogOutOfOrder {
  - vfLaterVersion :: VersionExtra
  - vfEarlierVersion :: VersionExtra
  }
- | CannotDowngrade {
  - vfFromVersion :: VersionExtra
  - vfToVersion :: VersionExtra
  }
- | ApiInvalid {
  - vfInvalidVersion :: VersionExtra
  - vfMissingDeclarations :: Set TypeName
  }
- | ChangelogEntryInvalid {
  - vfSuccessfullyApplied :: [APITableChange]
  - vfFailedToApply :: APIChange
  - vfApplyFailure :: ApplyFailure
  }
- | ChangelogIncomplete {
  }
data ValidateWarning
data ApplyFailure
- = TypeExists {
  - afExistingType :: TypeName
  }
- | TypeDoesNotExist {
  - afMissingType :: TypeName
  }
- | TypeWrongKind {
  - afTypeName :: TypeName
  - afExpectedKind :: TypeKind
  }
- | TypeInUse {
  - afTypeName :: TypeName
  }
- | TypeMalformed {
  - afType :: APIType
  - afMissingTypes :: Set TypeName
  }
- | DeclMalformed {
  - afTypeName :: TypeName
  - afDecl :: NormTypeDecl
  - afMissingTypes :: Set TypeName
  }
- | FieldExists {
  - afTypeName :: TypeName
  - afTypeKind :: TypeKind
  - afExistingField :: FieldName
  }
- | FieldDoesNotExist {
  - afTypeName :: TypeName
  - afTypeKind :: TypeKind
  - afMissingField :: FieldName
  }
- | FieldBadDefaultValue {
  - afTypeName :: TypeName
  - afFieldName :: FieldName
  - afFieldType :: APIType
  - afBadDefault :: DefaultValue
  }
- | DefaultMissing {
  - afTypeName :: TypeName
  - afFieldName :: FieldName
  }
- | TableChangeError {
  - afCustomMessage :: String
  }
data TypeKind
- = TKRecord
- | TKUnion
- | TKEnum
- | TKNewtype
- | TKTypeSynonym
data MigrateFailure
- = ValidateFailure ValidateFailure
- | ValueError ValueError Position
type MigrateWarning = ValidateWarning
prettyMigrateFailure :: MigrateFailure -> String
prettyValidateFailure :: ValidateFailure -> String
prettyValueError :: ValueError -> String
prettyValueErrorPosition :: (ValueError, Position) -> String

Representation of JSON parsing errors

data JSONError Source #

Represents an error that can be encountered while parsing

Instances

Instances details

Eq JSONError Source #
Instance details Defined in Data.API.Error Methods (==) :: JSONError -> JSONError -> Bool # (/=) :: JSONError -> JSONError -> Bool #
Show JSONError Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> JSONError -> ShowS # show :: JSONError -> String # showList :: [JSONError] -> ShowS #
ToJSON JSONError Source #
Instance details Defined in Data.API.Error Methods toJSON :: JSONError -> Value # toEncoding :: JSONError -> Encoding # toJSONList :: [JSONError] -> Value # toEncodingList :: [JSONError] -> Encoding #
FromJSON JSONError Source #
Instance details Defined in Data.API.Error Methods parseJSON :: Value -> Parser JSONError # parseJSONList :: Value -> Parser [JSONError] #

type JSONWarning = JSONError Source #

At present, we do not distinguish between errors and warnings

data Expected Source #

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

Constructors

ExpArray
ExpBool
ExpInt
ExpObject
ExpString

Instances

Instances details

Eq Expected Source #
Instance details Defined in Data.API.Error Methods (==) :: Expected -> Expected -> Bool # (/=) :: Expected -> Expected -> Bool #
Show Expected Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> Expected -> ShowS # show :: Expected -> String # showList :: [Expected] -> ShowS #
ToJSON Expected Source #
Instance details Defined in Data.API.Error Methods toJSON :: Expected -> Value # toEncoding :: Expected -> Encoding # toJSONList :: [Expected] -> Value # toEncodingList :: [Expected] -> Encoding #
FromJSON Expected Source #
Instance details Defined in Data.API.Error Methods parseJSON :: Value -> Parser Expected # parseJSONList :: Value -> Parser [Expected] #

data FormatExpected Source #

Special format expected of a string

Constructors

FmtBinary
FmtUTC
FmtOther

Instances

Instances details

Eq FormatExpected Source #
Instance details Defined in Data.API.Error Methods (==) :: FormatExpected -> FormatExpected -> Bool # (/=) :: FormatExpected -> FormatExpected -> Bool #
Show FormatExpected Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> FormatExpected -> ShowS # show :: FormatExpected -> String # showList :: [FormatExpected] -> ShowS #
ToJSON FormatExpected Source #
Instance details Defined in Data.API.Error Methods toJSON :: FormatExpected -> Value # toEncoding :: FormatExpected -> Encoding # toJSONList :: [FormatExpected] -> Value # toEncodingList :: [FormatExpected] -> Encoding #
FromJSON FormatExpected Source #
Instance details Defined in Data.API.Error Methods parseJSON :: Value -> Parser FormatExpected # parseJSONList :: Value -> Parser [FormatExpected] #

type Position = [Step] Source #

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

data Step Source #

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

Constructors

InField Text
InElem Int

Instances

Instances details

Eq Step Source #
Instance details Defined in Data.API.Error Methods (==) :: Step -> Step -> Bool # (/=) :: Step -> Step -> Bool #
Show Step Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> Step -> ShowS # show :: Step -> String # showList :: [Step] -> ShowS #
ToJSON Step Source #
Instance details Defined in Data.API.Error Methods toJSON :: Step -> Value # toEncoding :: Step -> Encoding # toJSONList :: [Step] -> Value # toEncodingList :: [Step] -> Encoding #
FromJSON Step Source #
Instance details Defined in Data.API.Error Methods parseJSON :: Value -> Parser Step # parseJSONList :: Value -> Parser [Step] #
SafeCopy Step Source #
Instance details Defined in Data.API.Error 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 Source #
Instance details Defined in Data.API.Error Methods ppLines :: Step -> [String] Source #

inField :: FieldName -> Step Source #

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

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

prettyJSONError :: JSONError -> String Source #

Human-readable description of a JSON parse error

prettyStep :: Step -> String Source #

Human-readable description of a single step in a position

JSON parse error construction

expectedArray :: Value -> JSONError Source #

expectedBool :: Value -> JSONError Source #

expectedInt :: Value -> JSONError Source #

expectedObject :: Value -> JSONError Source #

expectedString :: Value -> JSONError Source #

badFormat :: String -> Text -> JSONError Source #

Validation and migration errors

data ValueError Source #

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

Instances details

Eq ValueError Source #
Instance details Defined in Data.API.Error Methods (==) :: ValueError -> ValueError -> Bool # (/=) :: ValueError -> ValueError -> Bool #
Show ValueError Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> ValueError -> ShowS # show :: ValueError -> String # showList :: [ValueError] -> ShowS #
PPLines ValueError Source #
Instance details Defined in Data.API.Error Methods ppLines :: ValueError -> [String] Source #

data ValidateFailure Source #

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

Instances details

Eq ValidateFailure Source #
Instance details Defined in Data.API.Error Methods (==) :: ValidateFailure -> ValidateFailure -> Bool # (/=) :: ValidateFailure -> ValidateFailure -> Bool #
Show ValidateFailure Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> ValidateFailure -> ShowS # show :: ValidateFailure -> String # showList :: [ValidateFailure] -> ShowS #
PPLines ValidateFailure Source #
Instance details Defined in Data.API.Error Methods ppLines :: ValidateFailure -> [String] Source #

data ValidateWarning Source #

Instances

Instances details

Show ValidateWarning Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> ValidateWarning -> ShowS # show :: ValidateWarning -> String # showList :: [ValidateWarning] -> ShowS #

data ApplyFailure Source #

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

Instances details

Eq ApplyFailure Source #
Instance details Defined in Data.API.Error Methods (==) :: ApplyFailure -> ApplyFailure -> Bool # (/=) :: ApplyFailure -> ApplyFailure -> Bool #
Show ApplyFailure Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> ApplyFailure -> ShowS # show :: ApplyFailure -> String # showList :: [ApplyFailure] -> ShowS #
PPLines ApplyFailure Source #
Instance details Defined in Data.API.Error Methods ppLines :: ApplyFailure -> [String] Source #

data TypeKind Source #

Constructors

TKRecord
TKUnion
TKEnum
TKNewtype
TKTypeSynonym

Instances

Instances details

Eq TypeKind Source #
Instance details Defined in Data.API.Error Methods (==) :: TypeKind -> TypeKind -> Bool # (/=) :: TypeKind -> TypeKind -> Bool #
Show TypeKind Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> TypeKind -> ShowS # show :: TypeKind -> String # showList :: [TypeKind] -> ShowS #
PP TypeKind Source #
Instance details Defined in Data.API.Error Methods pp :: TypeKind -> String Source #

data MigrateFailure Source #

Constructors

ValidateFailure ValidateFailure
ValueError ValueError Position

Instances

Instances details

Eq MigrateFailure Source #
Instance details Defined in Data.API.Error Methods (==) :: MigrateFailure -> MigrateFailure -> Bool # (/=) :: MigrateFailure -> MigrateFailure -> Bool #
Show MigrateFailure Source #
Instance details Defined in Data.API.Error Methods showsPrec :: Int -> MigrateFailure -> ShowS # show :: MigrateFailure -> String # showList :: [MigrateFailure] -> ShowS #
PPLines MigrateFailure Source #
Instance details Defined in Data.API.Error Methods ppLines :: MigrateFailure -> [String] Source #

type MigrateWarning = ValidateWarning Source #

prettyMigrateFailure :: MigrateFailure -> String Source #

prettyValidateFailure :: ValidateFailure -> String Source #

prettyValueError :: ValueError -> String Source #

prettyValueErrorPosition :: (ValueError, Position) -> String Source #

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