servant-checked-exceptions-0.2.0.0: Checked exceptions for Servant APIs.

CopyrightDennis Gosnell 2017
LicenseBSD3
MaintainerDennis Gosnell ([email protected])
Stabilityexperimental
Portabilityunknown
Safe HaskellSafe
LanguageHaskell2010

Servant.Checked.Exceptions.Internal.Servant.API

Description

This module defines the Throws and Throwing types.

Synopsis

Documentation

data Throws e Source #

Throws is used in Servant API definitions and signifies that an API will throw the given error.

Here is an example of how to create an API that potentially returns a String as an error, or an Int on success:

>>> import Servant.API (Get, JSON, (:>))
>>> type API = Throws String :> Get '[JSON] Int

Instances

type Client * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) # 
type Client * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) = Client * ((:>) k * (Throwing (Snoc * es e)) api)
type Client * ((:>) k * (Throws e) api) # 
type Client * ((:>) k * (Throws e) api) = Client * ((:>) k * (Throwing ((:) * e ([] *))) api)
type ServerT * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) m # 
type ServerT * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) m = ServerT * ((:>) k * (Throwing (Snoc * es e)) api) m
type ServerT * ((:>) k * (Throws e) api) m # 
type ServerT * ((:>) k * (Throws e) api) m = ServerT * ((:>) k * (Throwing ((:) * e ([] *))) api) m

data Throwing e Source #

This is used internally and should not be used by end-users.

Instances

type Client * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) # 
type Client * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) = Client * ((:>) k * (Throwing (Snoc * es e)) api)
type Client * ((:>) * * (Throwing es) (Verb * k1 method status ctypes a)) # 
type Client * ((:>) * * (Throwing es) (Verb * k1 method status ctypes a)) = Client * (Verb * k1 method status ctypes (Envelope es a))
type ServerT * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) m # 
type ServerT * ((:>) * * (Throwing es) ((:>) k * (Throws e) api)) m = ServerT * ((:>) k * (Throwing (Snoc * es e)) api) m
type ServerT * ((:>) * * (Throwing es) (Verb * k1 method status ctypes a)) m # 
type ServerT * ((:>) * * (Throwing es) (Verb * k1 method status ctypes a)) m = ServerT * (Verb * k1 method status ctypes (Envelope es a)) m