| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Servant.Streaming.Client
Description
This module provides an instance for HasClient for 'servant-streaming' combinators, so that client functions can be generated for APIs that have streaming request or response bodies.
As as convenience, it also re-exports the combinators themselves.
Synopsis
- data StreamResponse (method :: StdMethod) (status :: Nat) (contentTypes :: [*])
- type StreamBody (ct :: [*]) = StreamBodyMonad ct IO
- type StreamResponseGet = StreamResponse GET 200
- type StreamResponsePost = StreamResponse POST 200
- type StreamResponsePut = StreamResponse PUT 200
- type StreamResponsePatch = StreamResponse PATCH 200
Documentation
data StreamResponse (method :: StdMethod) (status :: Nat) (contentTypes :: [*]) #
A response body that should be streamed, with specified method, status, and content-type.
Instances
| RunClient m => HasClient m (StreamResponse verb status contentTypes) # | |
Defined in Servant.Streaming.Client.Internal Associated Types type Client m (StreamResponse verb status contentTypes) :: * # Methods clientWithRoute :: Proxy m -> Proxy (StreamResponse verb status contentTypes) -> Request -> Client m (StreamResponse verb status contentTypes) # hoistClientMonad :: Proxy m -> Proxy (StreamResponse verb status contentTypes) -> (forall x. mon x -> mon' x) -> Client mon (StreamResponse verb status contentTypes) -> Client mon' (StreamResponse verb status contentTypes) # | |
| type Client m (StreamResponse verb status contentTypes) # | |
Defined in Servant.Streaming.Client.Internal type Client m (StreamResponse verb status contentTypes) = m (Stream (Of ByteString) (ResourceT IO) ()) | |
type StreamBody (ct :: [*]) = StreamBodyMonad ct IO #
A request body that should be streamed.
type StreamResponseGet = StreamResponse GET 200 #
The streaming version of the Get combinator.
type StreamResponsePost = StreamResponse POST 200 #
The streaming version of the Post combinator.
type StreamResponsePut = StreamResponse PUT 200 #
The streaming version of the Put combinator.
type StreamResponsePatch = StreamResponse PATCH 200 #
The streaming version of the Patch combinator.