Safe Haskell	Safe-Inferred
Language	Haskell2010

Twirp.Middleware.Errors

Description

Middlewares for handling Twirp error responses.

Synopsis

Documentation

A Twirp error that will be sent as a JSON-encoded response body. See: https://github.com/twitchtv/twirp/blob/master/docs/errors.md

Constructors

TwirpError
Fields code :: String msg :: String

Instances details

Generic TwirpError Source #
Instance details Defined in Twirp.Middleware.Errors Associated Types type Rep TwirpError :: Type -> Type # Methods from :: TwirpError -> Rep TwirpError x # to :: Rep TwirpError x -> TwirpError #
Show TwirpError Source #
Instance details Defined in Twirp.Middleware.Errors Methods showsPrec :: Int -> TwirpError -> ShowS # show :: TwirpError -> String # showList :: [TwirpError] -> ShowS #
Eq TwirpError Source #
Instance details Defined in Twirp.Middleware.Errors Methods (==) :: TwirpError -> TwirpError -> Bool # (/=) :: TwirpError -> TwirpError -> Bool #
FromJSON TwirpError Source #
Instance details Defined in Twirp.Middleware.Errors Methods parseJSON :: Value -> Parser TwirpError parseJSONList :: Value -> Parser [TwirpError]
ToJSON TwirpError Source #
Instance details Defined in Twirp.Middleware.Errors Methods toJSON :: TwirpError -> Value toEncoding :: TwirpError -> Encoding toJSONList :: [TwirpError] -> Value toEncodingList :: [TwirpError] -> Encoding
type Rep TwirpError Source #
Instance details Defined in Twirp.Middleware.Errors type Rep TwirpError = D1 ('MetaData "TwirpError" "Twirp.Middleware.Errors" "twirp-0.2.2.0-inplace" 'False) (C1 ('MetaCons "TwirpError" 'PrefixI 'True) (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :*: S1 ('MetaSel ('Just "msg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)))

Rewrite error responses to use Twirp's error codes and JSON encoding when they don't already fit that model.