GeniusYield.HTTP.Errors

Description

Synopsis

Documentation

class IsGYApiError e where #

Class of types that can be converted into an HTTP API error.

Minimal complete definition

Nothing

Methods

Instances details

IsGYApiError GYApiError #
Instance details Defined in GeniusYield.HTTP.Errors Methods toApiError ∷ GYApiError → GYApiError #

An example error code can be: INSUFFICIENT_BALANCE (i.e. it is not the HTTP status error message)

The message can be any textual representation of the error with more information.

The status code should be the HTTP status code.

Constructors

GYApiError
Fields gaeErrorCode ∷ Text gaeHttpStatus ∷ Status gaeMsg ∷ Text

Instances details

IsGYApiError GYApiError #
Instance details Defined in GeniusYield.HTTP.Errors Methods toApiError ∷ GYApiError → GYApiError #
Exception GYApiError #
Instance details Defined in GeniusYield.HTTP.Errors Methods toException ∷ GYApiError → SomeException # fromException ∷ SomeException → Maybe GYApiError # displayException ∷ GYApiError → String #
Show GYApiError #
Instance details Defined in GeniusYield.HTTP.Errors Methods showsPrec ∷ Int → GYApiError → ShowS # show ∷ GYApiError → String # showList ∷ [GYApiError] → ShowS #
Eq GYApiError #
Instance details Defined in GeniusYield.HTTP.Errors Methods (==) ∷ GYApiError → GYApiError → Bool # (/=) ∷ GYApiError → GYApiError → Bool #

Create a typical BACKEND_ERROR internal serval error with given message.