Safe Haskell	Safe-Inferred
Language	GHC2021

Network.Wai.Utilities.JSONResponse

Synopsis

data JSONResponse = JSONResponse {
- status :: Status
- value :: Value
}
waiErrorToJSONResponse :: Error -> JSONResponse
jsonResponseToWai :: JSONResponse -> Response

Documentation

data JSONResponse Source #

A custom JSON response to be returned to the client as an error.

Both static and dynamic errors are converted to this type before being turned into HTTP responses. It is a generalisation of Error, encompassing both standard error values (including label, code and message fields), and custom error-like responses that include extra data for the clients.

Constructors

JSONResponse
Fields status :: Status value :: Value

Instances

Instances details

FromJSON JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods parseJSON :: Value -> Parser JSONResponse Source # parseJSONList :: Value -> Parser [JSONResponse] Source #
ToJSON JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods toJSON :: JSONResponse -> Value Source # toEncoding :: JSONResponse -> Encoding Source # toJSONList :: [JSONResponse] -> Value Source # toEncodingList :: [JSONResponse] -> Encoding Source #
Exception JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods toException :: JSONResponse -> SomeException # fromException :: SomeException -> Maybe JSONResponse # displayException :: JSONResponse -> String #
Show JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods showsPrec :: Int -> JSONResponse -> ShowS # show :: JSONResponse -> String # showList :: [JSONResponse] -> ShowS #
Eq JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods (==) :: JSONResponse -> JSONResponse -> Bool # (/=) :: JSONResponse -> JSONResponse -> Bool #
Ord JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods compare :: JSONResponse -> JSONResponse -> Ordering # (<) :: JSONResponse -> JSONResponse -> Bool # (<=) :: JSONResponse -> JSONResponse -> Bool # (>) :: JSONResponse -> JSONResponse -> Bool # (>=) :: JSONResponse -> JSONResponse -> Bool # max :: JSONResponse -> JSONResponse -> JSONResponse # min :: JSONResponse -> JSONResponse -> JSONResponse #
ToSchema JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods declareNamedSchema :: Proxy JSONResponse -> Declare (Definitions Schema) NamedSchema Source #
ToSchema JSONResponse Source #
Instance details Defined in Network.Wai.Utilities.JSONResponse Methods schema :: ValueSchema NamedSwaggerDoc JSONResponse Source #

waiErrorToJSONResponse :: Error -> JSONResponse Source #

jsonResponseToWai :: JSONResponse -> Response Source #