| Safe Haskell | None |
|---|
Rest.Dictionary.Types
- data Format
- = XmlFormat
- | JsonFormat
- | StringFormat
- | FileFormat
- | MultipartFormat
- | NoFormat
- data Dict h p i o e
- headers :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict a p i o e) (Header h -> Header a)
- params :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h a i o e) (Param p -> Param a)
- inputs :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h p a o e) (Inputs i -> Inputs a)
- outputs :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h p i a e) (Outputs o -> Outputs a)
- errors :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h p i o a) (Errors e -> Errors a)
- empty :: Dict () () () () ()
- type Modifier h p i o e = Dict () () () () () -> Dict h p i o e
- data Ident id where
- data Header h where
- data Param p where
- data Input i where
- data Output o where
- data Error e where
- data Dicts f a where
- dicts :: Dicts f a :-> [f a]
- type Inputs i = Dicts Input i
- type Outputs o = Dicts Output o
- type Errors e = Dicts Error e
- data SomeError where
Possible I/O formats.
The Format datatype enumerates all input and output formats we might recognize.
Constructors
| XmlFormat | |
| JsonFormat | |
| StringFormat | |
| FileFormat | |
| MultipartFormat | |
| NoFormat |
The dictionary type.
The Dict datatype containing sub-dictionaries for translation of
identifiers (i), headers (h), parameters (p), inputs (i), outputs (o), and
errors (e). Inputs, outputs and errors can have multiple associated
dictionaries.
headers :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict a p i o e) (Header h -> Header a)Source
params :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h a i o e) (Param p -> Param a)Source
inputs :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h p a o e) (Inputs i -> Inputs a)Source
outputs :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h p i a e) (Outputs o -> Outputs a)Source
errors :: forall cat h p i o e a. ArrowApply cat => Lens cat (Dict h p i o e -> Dict h p i o a) (Errors e -> Errors a)Source
type Modifier h p i o e = Dict () () () () () -> Dict h p i o eSource
Type synonym for dictionary modification.
Dictionary aspects.
The explicit dictionary Header describes how to translate HTTP request
headers to some Haskell value. The first field in the Header constructor
is a white list of headers we can recognize, used in generic validation and
for generating documentation. The second field is a custom parser that can
fail with a DataError or can produce a some value. When explicitly not
interested in the headers we can use NoHeader.
The explicit dictionary Parameter describes how to translate the request
parameters to some Haskell value. The first field in the Header
constructor is a white list of paramters we can recognize, used in generic
validation and for generating documentation. The second field is a custom
parser that can fail with a DataError or can produce a some value. When
explicitly not interested in the parameters we can use NoParam.
The explicitly dictionary Input describes how to translate the request
body into some Haskell value. We currently use a constructor for every
combination of input type to output type. For example, we can use XML input
in multiple ways, parsed, as plain/text or as raw bytes, depending on the
needs of the backend resource.
The explicitly dictionary Output describes how to translate some Haskell
value to a response body. We currently use a constructor for every
combination of input type to output type.
The explicitly dictionary Error describes how to translate some Haskell
error value to a response body.