Safe Haskell	None
Language	Haskell2010

Servant.Client.Core.Reexport

Contents

HasClient
Response (for Raw)
Generic Client
BaseUrl

Description

This module is a utility for servant-client-core backend writers. It contains all the functionality from servant-client-core that should be re-exported.

Synopsis

class RunClient m => HasClient m api where
- type Client (m :: * -> *) (api :: *) :: *
- clientWithRoute :: Proxy m -> Proxy api -> Request -> Client m api
- hoistClientMonad :: Proxy m -> Proxy api -> (forall x. mon x -> mon' x) -> Client mon api -> Client mon' api
type Response = GenResponse ByteString
type StreamingResponse = GenResponse (IO ByteString)
data GenResponse a = Response {
- responseStatusCode :: Status
- responseHeaders :: Seq Header
- responseHttpVersion :: HttpVersion
- responseBody :: a
}
class ClientLike client custom where
- mkClient :: client -> custom
genericMkClientL :: (Generic custom, Code custom ~ '[xs], GClientList client '[], GClientLikeL (ClientList client '[]) xs) => client -> custom
genericMkClientP :: (Generic custom, Code custom ~ '[xs], GClientLikeP client xs) => client -> custom
data ServantError
data EmptyClient = EmptyClient
data BaseUrl = BaseUrl {
- baseUrlScheme :: Scheme
- baseUrlHost :: String
- baseUrlPort :: Int
- baseUrlPath :: String
}
data Scheme
- = Http
- | Https
showBaseUrl :: BaseUrl -> String
parseBaseUrl :: MonadThrow m => String -> m BaseUrl
data InvalidBaseUrlException

HasClient

class RunClient m => HasClient m api where Source #

This class lets us define how each API combinator influences the creation of an HTTP request.

Unless you are writing a new backend for servant-client-core or new combinators that you want to support client-generation, you can ignore this class.

Associated Types

type Client (m :: * -> *) (api :: *) :: * Source #

Methods

clientWithRoute :: Proxy m -> Proxy api -> Request -> Client m api Source #

hoistClientMonad :: Proxy m -> Proxy api -> (forall x. mon x -> mon' x) -> Client mon api -> Client mon' api Source #

Instances

RunClient m => HasClient m Raw Source #	Pick a `Method` and specify where the server you want to query is. You get back the full `GenResponse`.
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m Raw :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy Raw -> Request -> Client m Raw Source # hoistClientMonad :: Proxy m -> Proxy Raw -> (forall x. mon x -> mon' x) -> Client mon Raw -> Client mon' Raw Source #
RunClient m => HasClient m EmptyAPI Source #	The client for `EmptyAPI` is simply `EmptyClient`. type MyAPI = "books" :> Get '[JSON] [Book] -- GET /books :<\|> "nothing" :> EmptyAPI myApi :: Proxy MyApi myApi = Proxy getAllBooks :: ClientM [Book] (getAllBooks :<\|> EmptyClient) = client myApi
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m EmptyAPI :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy EmptyAPI -> Request -> Client m EmptyAPI Source # hoistClientMonad :: Proxy m -> Proxy EmptyAPI -> (forall x. mon x -> mon' x) -> Client mon EmptyAPI -> Client mon' EmptyAPI Source #
(HasClient m a, HasClient m b) => HasClient m (a :<\|> b) Source #	A client querying function for `a :<\|> b` will actually hand you one function for querying `a` and another one for querying `b`, stitching them together with `:<\|>`, which really is just like a pair. type MyApi = "books" :> Get '[JSON] [Book] -- GET /books :<\|> "books" :> ReqBody '[JSON] Book :> Post Book -- POST /books myApi :: Proxy MyApi myApi = Proxy getAllBooks :: ClientM [Book] postNewBook :: Book -> ClientM Book (getAllBooks :<\|> postNewBook) = client myApi
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (a :<\|> b) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (a :<\|> b) -> Request -> Client m (a :<\|> b) Source # hoistClientMonad :: Proxy m -> Proxy (a :<\|> b) -> (forall x. mon x -> mon' x) -> Client mon (a :<\|> b) -> Client mon' (a :<\|> b) Source #
HasClient m api => HasClient m (BasicAuth realm usr :> api) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (BasicAuth realm usr :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (BasicAuth realm usr :> api) -> Request -> Client m (BasicAuth realm usr :> api) Source # hoistClientMonad :: Proxy m -> Proxy (BasicAuth realm usr :> api) -> (forall x. mon x -> mon' x) -> Client mon (BasicAuth realm usr :> api) -> Client mon' (BasicAuth realm usr :> api) Source #
HasClient m api => HasClient m (AuthProtect tag :> api) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (AuthProtect tag :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (AuthProtect tag :> api) -> Request -> Client m (AuthProtect tag :> api) Source # hoistClientMonad :: Proxy m -> Proxy (AuthProtect tag :> api) -> (forall x. mon x -> mon' x) -> Client mon (AuthProtect tag :> api) -> Client mon' (AuthProtect tag :> api) Source #
HasClient m subapi => HasClient m (WithNamedContext name context subapi) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (WithNamedContext name context subapi) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (WithNamedContext name context subapi) -> Request -> Client m (WithNamedContext name context subapi) Source # hoistClientMonad :: Proxy m -> Proxy (WithNamedContext name context subapi) -> (forall x. mon x -> mon' x) -> Client mon (WithNamedContext name context subapi) -> Client mon' (WithNamedContext name context subapi) Source #
HasClient m api => HasClient m (IsSecure :> api) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (IsSecure :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (IsSecure :> api) -> Request -> Client m (IsSecure :> api) Source # hoistClientMonad :: Proxy m -> Proxy (IsSecure :> api) -> (forall x. mon x -> mon' x) -> Client mon (IsSecure :> api) -> Client mon' (IsSecure :> api) Source #
HasClient m api => HasClient m (RemoteHost :> api) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (RemoteHost :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (RemoteHost :> api) -> Request -> Client m (RemoteHost :> api) Source # hoistClientMonad :: Proxy m -> Proxy (RemoteHost :> api) -> (forall x. mon x -> mon' x) -> Client mon (RemoteHost :> api) -> Client mon' (RemoteHost :> api) Source #
HasClient m api => HasClient m (Vault :> api) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Vault :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Vault :> api) -> Request -> Client m (Vault :> api) Source # hoistClientMonad :: Proxy m -> Proxy (Vault :> api) -> (forall x. mon x -> mon' x) -> Client mon (Vault :> api) -> Client mon' (Vault :> api) Source #
(KnownSymbol path, HasClient m api) => HasClient m (path :> api) Source #	Make the querying function append `path` to the request path.
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (path :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (path :> api) -> Request -> Client m (path :> api) Source # hoistClientMonad :: Proxy m -> Proxy (path :> api) -> (forall x. mon x -> mon' x) -> Client mon (path :> api) -> Client mon' (path :> api) Source #
HasClient m api => HasClient m (StreamBody' mods framing ctype a :> api) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (StreamBody' mods framing ctype a :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (StreamBody' mods framing ctype a :> api) -> Request -> Client m (StreamBody' mods framing ctype a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (StreamBody' mods framing ctype a :> api) -> (forall x. mon x -> mon' x) -> Client mon (StreamBody' mods framing ctype a :> api) -> Client mon' (StreamBody' mods framing ctype a :> api) Source #
(MimeRender ct a, HasClient m api) => HasClient m (ReqBody' mods (ct ': cts) a :> api) Source #	If you use a `ReqBody` in one of your endpoints in your API, the corresponding querying function will automatically take an additional argument of the type specified by your `ReqBody`. That function will take care of encoding this argument as JSON and of using it as the request body. All you need is for your type to have a `ToJSON` instance. Example: type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book myApi :: Proxy MyApi myApi = Proxy addBook :: Book -> ClientM Book addBook = client myApi -- then you can just use "addBook" to query that endpoint
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (ReqBody' mods (ct ': cts) a :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (ReqBody' mods (ct ': cts) a :> api) -> Request -> Client m (ReqBody' mods (ct ': cts) a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (ReqBody' mods (ct ': cts) a :> api) -> (forall x. mon x -> mon' x) -> Client mon (ReqBody' mods (ct ': cts) a :> api) -> Client mon' (ReqBody' mods (ct ': cts) a :> api) Source #
(KnownSymbol sym, HasClient m api) => HasClient m (QueryFlag sym :> api) Source #	If you use a `QueryFlag` in one of your endpoints in your API, the corresponding querying function will automatically take an additional `Bool` argument. If you give `False`, nothing will be added to the query string. Otherwise, this function will insert a value-less query string parameter under the name associated to your `QueryFlag`. Example: type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book] myApi :: Proxy MyApi myApi = Proxy getBooks :: Bool -> ClientM [Book] getBooks = client myApi -- then you can just use "getBooks" to query that endpoint. -- 'getBooksBy False' for all books -- 'getBooksBy True' to only get _already published_ books
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (QueryFlag sym :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (QueryFlag sym :> api) -> Request -> Client m (QueryFlag sym :> api) Source # hoistClientMonad :: Proxy m -> Proxy (QueryFlag sym :> api) -> (forall x. mon x -> mon' x) -> Client mon (QueryFlag sym :> api) -> Client mon' (QueryFlag sym :> api) Source #
(KnownSymbol sym, ToHttpApiData a, HasClient m api) => HasClient m (QueryParams sym a :> api) Source #	If you use a `QueryParams` in one of your endpoints in your API, the corresponding querying function will automatically take an additional argument, a list of values of the type specified by your `QueryParams`. If you give an empty list, nothing will be added to the query string. Otherwise, this function will take care of inserting a textual representation of your values in the query string, under the same query string parameter name. You can control how values for your type are turned into text by specifying a `ToHttpApiData` instance for your type. Example: type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book] myApi :: Proxy MyApi myApi = Proxy getBooksBy :: [Text] -> ClientM [Book] getBooksBy = client myApi -- then you can just use "getBooksBy" to query that endpoint. -- 'getBooksBy []' for all books -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]' -- to get all books by Asimov and Heinlein
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (QueryParams sym a :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (QueryParams sym a :> api) -> Request -> Client m (QueryParams sym a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (QueryParams sym a :> api) -> (forall x. mon x -> mon' x) -> Client mon (QueryParams sym a :> api) -> Client mon' (QueryParams sym a :> api) Source #
(KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequired mods)) => HasClient m (QueryParam' mods sym a :> api) Source #	If you use a `QueryParam` in one of your endpoints in your API, the corresponding querying function will automatically take an additional argument of the type specified by your `QueryParam`, enclosed in Maybe. If you give Nothing, nothing will be added to the query string. If you give a non-`Nothing` value, this function will take care of inserting a textual representation of this value in the query string. You can control how values for your type are turned into text by specifying a `ToHttpApiData` instance for your type. Example: type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book] myApi :: Proxy MyApi myApi = Proxy getBooksBy :: Maybe Text -> ClientM [Book] getBooksBy = client myApi -- then you can just use "getBooksBy" to query that endpoint. -- 'getBooksBy Nothing' for all books -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (QueryParam' mods sym a :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (QueryParam' mods sym a :> api) -> Request -> Client m (QueryParam' mods sym a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (QueryParam' mods sym a :> api) -> (forall x. mon x -> mon' x) -> Client mon (QueryParam' mods sym a :> api) -> Client mon' (QueryParam' mods sym a :> api) Source #
HasClient m api => HasClient m (Description desc :> api) Source #	Ignore `Description` in client functions.
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Description desc :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Description desc :> api) -> Request -> Client m (Description desc :> api) Source # hoistClientMonad :: Proxy m -> Proxy (Description desc :> api) -> (forall x. mon x -> mon' x) -> Client mon (Description desc :> api) -> Client mon' (Description desc :> api) Source #
HasClient m api => HasClient m (Summary desc :> api) Source #	Ignore `Summary` in client functions.
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Summary desc :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Summary desc :> api) -> Request -> Client m (Summary desc :> api) Source # hoistClientMonad :: Proxy m -> Proxy (Summary desc :> api) -> (forall x. mon x -> mon' x) -> Client mon (Summary desc :> api) -> Client mon' (Summary desc :> api) Source #
HasClient m api => HasClient m (HttpVersion :> api) Source #	Using a `HttpVersion` combinator in your API doesn't affect the client functions.
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (HttpVersion :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (HttpVersion :> api) -> Request -> Client m (HttpVersion :> api) Source # hoistClientMonad :: Proxy m -> Proxy (HttpVersion :> api) -> (forall x. mon x -> mon' x) -> Client mon (HttpVersion :> api) -> Client mon' (HttpVersion :> api) Source #
(KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequired mods)) => HasClient m (Header' mods sym a :> api) Source #	If you use a `Header` in one of your endpoints in your API, the corresponding querying function will automatically take an additional argument of the type specified by your `Header`, wrapped in Maybe. That function will take care of encoding this argument as Text in the request headers. All you need is for your type to have a `ToHttpApiData` instance. Example: newtype Referer = Referer { referrer :: Text } deriving (Eq, Show, Generic, ToHttpApiData) -- GET /view-my-referer type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer myApi :: Proxy MyApi myApi = Proxy viewReferer :: Maybe Referer -> ClientM Book viewReferer = client myApi -- then you can just use "viewRefer" to query that endpoint -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Header' mods sym a :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Header' mods sym a :> api) -> Request -> Client m (Header' mods sym a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (Header' mods sym a :> api) -> (forall x. mon x -> mon' x) -> Client mon (Header' mods sym a :> api) -> Client mon' (Header' mods sym a :> api) Source #
(KnownSymbol capture, ToHttpApiData a, HasClient m sublayout) => HasClient m (CaptureAll capture a :> sublayout) Source #	If you use a `CaptureAll` in one of your endpoints in your API, the corresponding querying function will automatically take an additional argument of a list of the type specified by your `CaptureAll`. That function will take care of inserting a textual representation of this value at the right place in the request path. You can control how these values are turned into text by specifying a `ToHttpApiData` instance of your type. Example: type MyAPI = "src" :> CaptureAll Text -> Get '[JSON] SourceFile myApi :: Proxy myApi = Proxy getSourceFile :: [Text] -> ClientM SourceFile getSourceFile = client myApi -- then you can use "getSourceFile" to query that endpoint
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (CaptureAll capture a :> sublayout) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (CaptureAll capture a :> sublayout) -> Request -> Client m (CaptureAll capture a :> sublayout) Source # hoistClientMonad :: Proxy m -> Proxy (CaptureAll capture a :> sublayout) -> (forall x. mon x -> mon' x) -> Client mon (CaptureAll capture a :> sublayout) -> Client mon' (CaptureAll capture a :> sublayout) Source #
(KnownSymbol capture, ToHttpApiData a, HasClient m api) => HasClient m (Capture' mods capture a :> api) Source #	If you use a `Capture` in one of your endpoints in your API, the corresponding querying function will automatically take an additional argument of the type specified by your `Capture`. That function will take care of inserting a textual representation of this value at the right place in the request path. You can control how values for this type are turned into text by specifying a `ToHttpApiData` instance for your type. Example: type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book myApi :: Proxy MyApi myApi = Proxy getBook :: Text -> ClientM Book getBook = client myApi -- then you can just use "getBook" to query that endpoint
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Capture' mods capture a :> api) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Capture' mods capture a :> api) -> Request -> Client m (Capture' mods capture a :> api) Source # hoistClientMonad :: Proxy m -> Proxy (Capture' mods capture a :> api) -> (forall x. mon x -> mon' x) -> Client mon (Capture' mods capture a :> api) -> Client mon' (Capture' mods capture a :> api) Source #
(RunClient m, BuildHeadersTo ls, ReflectMethod method) => HasClient m (Verb method status cts (Headers ls NoContent)) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Verb method status cts (Headers ls NoContent)) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Verb method status cts (Headers ls NoContent)) -> Request -> Client m (Verb method status cts (Headers ls NoContent)) Source # hoistClientMonad :: Proxy m -> Proxy (Verb method status cts (Headers ls NoContent)) -> (forall x. mon x -> mon' x) -> Client mon (Verb method status cts (Headers ls NoContent)) -> Client mon' (Verb method status cts (Headers ls NoContent)) Source #
(RunClient m, MimeUnrender ct a, BuildHeadersTo ls, ReflectMethod method, cts' ~ (ct ': cts)) => HasClient m (Verb method status cts' (Headers ls a)) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Verb method status cts' (Headers ls a)) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Verb method status cts' (Headers ls a)) -> Request -> Client m (Verb method status cts' (Headers ls a)) Source # hoistClientMonad :: Proxy m -> Proxy (Verb method status cts' (Headers ls a)) -> (forall x. mon x -> mon' x) -> Client mon (Verb method status cts' (Headers ls a)) -> Client mon' (Verb method status cts' (Headers ls a)) Source #
(RunClient m, ReflectMethod method) => HasClient m (Verb method status cts NoContent) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Verb method status cts NoContent) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Verb method status cts NoContent) -> Request -> Client m (Verb method status cts NoContent) Source # hoistClientMonad :: Proxy m -> Proxy (Verb method status cts NoContent) -> (forall x. mon x -> mon' x) -> Client mon (Verb method status cts NoContent) -> Client mon' (Verb method status cts NoContent) Source #
(RunClient m, MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts)) => HasClient m (Verb method status cts' a) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Verb method status cts' a) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Verb method status cts' a) -> Request -> Client m (Verb method status cts' a) Source # hoistClientMonad :: Proxy m -> Proxy (Verb method status cts' a) -> (forall x. mon x -> mon' x) -> Client mon (Verb method status cts' a) -> Client mon' (Verb method status cts' a) Source #
(RunStreamingClient m, MimeUnrender ct chunk, ReflectMethod method, FramingUnrender framing, FromSourceIO chunk a) => HasClient m (Stream method status framing ct a) Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Associated Types type Client m (Stream method status framing ct a) :: Type Source # Methods clientWithRoute :: Proxy m -> Proxy (Stream method status framing ct a) -> Request -> Client m (Stream method status framing ct a) Source # hoistClientMonad :: Proxy m -> Proxy (Stream method status framing ct a) -> (forall x. mon x -> mon' x) -> Client mon (Stream method status framing ct a) -> Client mon' (Stream method status framing ct a) Source #

Response (for `Raw`)

type Response = GenResponse ByteString Source #

type StreamingResponse = GenResponse (IO ByteString) Source #

data GenResponse a Source #

Constructors

Response
Fields responseStatusCode :: Status responseHeaders :: Seq Header responseHttpVersion :: HttpVersion responseBody :: a

Instances

Functor GenResponse Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods fmap :: (a -> b) -> GenResponse a -> GenResponse b # (<$) :: a -> GenResponse b -> GenResponse a #
Foldable GenResponse Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods fold :: Monoid m => GenResponse m -> m # foldMap :: Monoid m => (a -> m) -> GenResponse a -> m # foldr :: (a -> b -> b) -> b -> GenResponse a -> b # foldr' :: (a -> b -> b) -> b -> GenResponse a -> b # foldl :: (b -> a -> b) -> b -> GenResponse a -> b # foldl' :: (b -> a -> b) -> b -> GenResponse a -> b # foldr1 :: (a -> a -> a) -> GenResponse a -> a # foldl1 :: (a -> a -> a) -> GenResponse a -> a # toList :: GenResponse a -> [a] # null :: GenResponse a -> Bool # length :: GenResponse a -> Int # elem :: Eq a => a -> GenResponse a -> Bool # maximum :: Ord a => GenResponse a -> a # minimum :: Ord a => GenResponse a -> a # sum :: Num a => GenResponse a -> a # product :: Num a => GenResponse a -> a #
Traversable GenResponse Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods traverse :: Applicative f => (a -> f b) -> GenResponse a -> f (GenResponse b) # sequenceA :: Applicative f => GenResponse (f a) -> f (GenResponse a) # mapM :: Monad m => (a -> m b) -> GenResponse a -> m (GenResponse b) # sequence :: Monad m => GenResponse (m a) -> m (GenResponse a) #
Eq a => Eq (GenResponse a) Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods (==) :: GenResponse a -> GenResponse a -> Bool # (/=) :: GenResponse a -> GenResponse a -> Bool #
Show a => Show (GenResponse a) Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods showsPrec :: Int -> GenResponse a -> ShowS # show :: GenResponse a -> String # showList :: [GenResponse a] -> ShowS #
Generic (GenResponse a) Source #
Instance details Defined in Servant.Client.Core.Internal.Request Associated Types type Rep (GenResponse a) :: Type -> Type # Methods from :: GenResponse a -> Rep (GenResponse a) x # to :: Rep (GenResponse a) x -> GenResponse a #
NFData a => NFData (GenResponse a) Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods rnf :: GenResponse a -> () #
type Rep (GenResponse a) Source #
Instance details Defined in Servant.Client.Core.Internal.Request type Rep (GenResponse a) = D1 (MetaData "GenResponse" "Servant.Client.Core.Internal.Request" "servant-client-core-0.15-BELfpAH4M6qDJZvAfR1UCC" False) (C1 (MetaCons "Response" PrefixI True) ((S1 (MetaSel (Just "responseStatusCode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Status) :: S1 (MetaSel (Just "responseHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Seq Header))) :: (S1 (MetaSel (Just "responseHttpVersion") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HttpVersion) :*: S1 (MetaSel (Just "responseBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))

Generic Client

class ClientLike client custom where Source #

This class allows us to match client structure with client functions produced with client without explicit pattern-matching.

The client structure needs a Generic instance.

Example:

type API
    = "foo" :> Capture "x" Int :> Get '[JSON] Int
 :<|> "bar" :> QueryParam "a" Char :> QueryParam "b" String :> Post '[JSON] [Int]
 :<|> Capture "nested" Int :> NestedAPI

type NestedAPI
    = Get '[JSON] String
 :<|> "baz" :> QueryParam "c" Char :> Post '[JSON] ()

data APIClient = APIClient
  { getFoo         :: Int -> ClientM Int
  , postBar        :: Maybe Char -> Maybe String -> ClientM [Int]
  , mkNestedClient :: Int -> NestedClient
  } deriving GHC.Generic

instance Generics.SOP.Generic APIClient
instance (Client API ~ client) => ClientLike client APIClient

data NestedClient = NestedClient
 { getString :: ClientM String
 , postBaz   :: Maybe Char -> ClientM ()
 } deriving GHC.Generic

instance Generics.SOP.Generic NestedClient
instance (Client NestedAPI ~ client) => ClientLike client NestedClient

mkAPIClient :: APIClient
mkAPIClient = mkClient (client (Proxy :: Proxy API))

By default, left-nested alternatives are expanded:

type API1
    = "foo" :> Capture "x" Int :> Get '[JSON] Int
 :<|> "bar" :> QueryParam "a" Char :> Post '[JSON] String

type API2
    = "baz" :> QueryParam "c" Char :> Post '[JSON] ()

type API = API1 :<|> API2

data APIClient = APIClient
  { getFoo  :: Int -> ClientM Int
  , postBar :: Maybe Char -> ClientM String
  , postBaz :: Maybe Char -> ClientM ()
  } deriving GHC.Generic

instance Generics.SOP.Generic APIClient
instance (Client API ~ client) => ClientLike client APIClient

mkAPIClient :: APIClient
mkAPIClient = mkClient (client (Proxy :: Proxy API))

If you want to define client for API1 as a separate data structure, you can use genericMkClientP:

data APIClient1 = APIClient1
  { getFoo  :: Int -> ClientM Int
  , postBar :: Maybe Char -> ClientM String
  } deriving GHC.Generic

instance Generics.SOP.Generic APIClient1
instance (Client API1 ~ client) => ClientLike client APIClient1

data APIClient = APIClient
  { mkAPIClient1 :: APIClient1
  , postBaz      :: Maybe Char -> ClientM ()
  } deriving GHC.Generic

instance Generics.SOP.Generic APIClient
instance (Client API ~ client) => ClientLike client APIClient where
  mkClient = genericMkClientP

mkAPIClient :: APIClient
mkAPIClient = mkClient (client (Proxy :: Proxy API))

Minimal complete definition

Nothing

Methods

mkClient :: client -> custom Source #

mkClient :: (Generic custom, Code custom ~ '[xs], GClientList client '[], GClientLikeL (ClientList client '[]) xs) => client -> custom Source #

Instances

ClientLike client custom => ClientLike (a -> client) (a -> custom) Source #
Instance details Defined in Servant.Client.Core.Internal.Generic Methods mkClient :: (a -> client) -> a -> custom Source #

genericMkClientL :: (Generic custom, Code custom ~ '[xs], GClientList client '[], GClientLikeL (ClientList client '[]) xs) => client -> custom Source #

Generate client structure from client type, expanding left-nested API (done by default).

genericMkClientP :: (Generic custom, Code custom ~ '[xs], GClientLikeP client xs) => client -> custom Source #

Generate client structure from client type, regarding left-nested API clients as separate data structures.

data ServantError Source #

A type representing possible errors in a request

Note that this type substantially changed in 0.12.

Constructors

FailureResponse Response	The server returned an error response
DecodeFailure Text Response	The body could not be decoded at the expected type
UnsupportedContentType MediaType Response	The content-type of the response is not supported
InvalidContentTypeHeader Response	The content-type header is invalid
ConnectionError Text	There was a connection error, and no response was received

Instances

Eq ServantError Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods (==) :: ServantError -> ServantError -> Bool # (/=) :: ServantError -> ServantError -> Bool #
Show ServantError Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods showsPrec :: Int -> ServantError -> ShowS # show :: ServantError -> String # showList :: [ServantError] -> ShowS #
Generic ServantError Source #
Instance details Defined in Servant.Client.Core.Internal.Request Associated Types type Rep ServantError :: Type -> Type # Methods from :: ServantError -> Rep ServantError x # to :: Rep ServantError x -> ServantError #
Exception ServantError Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods toException :: ServantError -> SomeException # fromException :: SomeException -> Maybe ServantError # displayException :: ServantError -> String #
NFData ServantError Source #
Instance details Defined in Servant.Client.Core.Internal.Request Methods rnf :: ServantError -> () #
type Rep ServantError Source #
Instance details Defined in Servant.Client.Core.Internal.Request type Rep ServantError = D1 (MetaData "ServantError" "Servant.Client.Core.Internal.Request" "servant-client-core-0.15-BELfpAH4M6qDJZvAfR1UCC" False) ((C1 (MetaCons "FailureResponse" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response)) :+: C1 (MetaCons "DecodeFailure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response))) :+: (C1 (MetaCons "UnsupportedContentType" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MediaType) :: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response)) :+: (C1 (MetaCons "InvalidContentTypeHeader" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Response)) :+: C1 (MetaCons "ConnectionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

data EmptyClient Source #

Singleton type representing a client for an empty API.

Constructors

EmptyClient

Instances

Bounded EmptyClient Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Methods minBound :: EmptyClient # maxBound :: EmptyClient #
Enum EmptyClient Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Methods succ :: EmptyClient -> EmptyClient # pred :: EmptyClient -> EmptyClient # toEnum :: Int -> EmptyClient # fromEnum :: EmptyClient -> Int # enumFrom :: EmptyClient -> [EmptyClient] # enumFromThen :: EmptyClient -> EmptyClient -> [EmptyClient] # enumFromTo :: EmptyClient -> EmptyClient -> [EmptyClient] # enumFromThenTo :: EmptyClient -> EmptyClient -> EmptyClient -> [EmptyClient] #
Eq EmptyClient Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Methods (==) :: EmptyClient -> EmptyClient -> Bool # (/=) :: EmptyClient -> EmptyClient -> Bool #
Show EmptyClient Source #
Instance details Defined in Servant.Client.Core.Internal.HasClient Methods showsPrec :: Int -> EmptyClient -> ShowS # show :: EmptyClient -> String # showList :: [EmptyClient] -> ShowS #

BaseUrl

data BaseUrl Source #

Simple data type to represent the target of HTTP requests for servant's automatically-generated clients.

Constructors

BaseUrl
Fields baseUrlScheme :: Scheme URI scheme to use baseUrlHost :: String host (eg "haskell.org") baseUrlPort :: Int port (eg 80) baseUrlPath :: String path (eg "ab/c")

Instances

Eq BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods (==) :: BaseUrl -> BaseUrl -> Bool # (/=) :: BaseUrl -> BaseUrl -> Bool #
Data BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BaseUrl -> c BaseUrl # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BaseUrl # toConstr :: BaseUrl -> Constr # dataTypeOf :: BaseUrl -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BaseUrl) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BaseUrl) # gmapT :: (forall b. Data b => b -> b) -> BaseUrl -> BaseUrl # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BaseUrl -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BaseUrl -> r # gmapQ :: (forall d. Data d => d -> u) -> BaseUrl -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BaseUrl -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BaseUrl -> m BaseUrl # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BaseUrl -> m BaseUrl # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BaseUrl -> m BaseUrl #
Ord BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods compare :: BaseUrl -> BaseUrl -> Ordering # (<) :: BaseUrl -> BaseUrl -> Bool # (<=) :: BaseUrl -> BaseUrl -> Bool # (>) :: BaseUrl -> BaseUrl -> Bool # (>=) :: BaseUrl -> BaseUrl -> Bool # max :: BaseUrl -> BaseUrl -> BaseUrl # min :: BaseUrl -> BaseUrl -> BaseUrl #
Show BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods showsPrec :: Int -> BaseUrl -> ShowS # show :: BaseUrl -> String # showList :: [BaseUrl] -> ShowS #
Generic BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Associated Types type Rep BaseUrl :: Type -> Type # Methods from :: BaseUrl -> Rep BaseUrl x # to :: Rep BaseUrl x -> BaseUrl #
Lift BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods lift :: BaseUrl -> Q Exp #
ToJSON BaseUrl Source #	`>>>` `traverse_ (LBS8.putStrLn . encode) $ parseBaseUrl "api.example.com"`"http://api.example.com"
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods toJSON :: BaseUrl -> Value # toEncoding :: BaseUrl -> Encoding # toJSONList :: [BaseUrl] -> Value # toEncodingList :: [BaseUrl] -> Encoding #
ToJSONKey BaseUrl Source #	`>>>` `:{`traverse_ (LBS8.putStrLn . encode) $ do u1 <- parseBaseUrl "api.example.com" u2 <- parseBaseUrl "example.com" return $ Map.fromList [(u1, 'x'), (u2, 'y')] :} {"http://api.example.com":"x","http://example.com":"y"}
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods toJSONKey :: ToJSONKeyFunction BaseUrl # toJSONKeyList :: ToJSONKeyFunction [BaseUrl] #
FromJSON BaseUrl Source #	`>>>` `parseBaseUrl "api.example.com" >>= decode . encode :: Maybe BaseUrl`Just (BaseUrl {baseUrlScheme = Http, baseUrlHost = "api.example.com", baseUrlPort = 80, baseUrlPath = ""})
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods parseJSON :: Value -> Parser BaseUrl # parseJSONList :: Value -> Parser [BaseUrl] #
FromJSONKey BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods fromJSONKey :: FromJSONKeyFunction BaseUrl # fromJSONKeyList :: FromJSONKeyFunction [BaseUrl] #
type Rep BaseUrl Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl type Rep BaseUrl = D1 (MetaData "BaseUrl" "Servant.Client.Core.Internal.BaseUrl" "servant-client-core-0.15-BELfpAH4M6qDJZvAfR1UCC" False) (C1 (MetaCons "BaseUrl" PrefixI True) ((S1 (MetaSel (Just "baseUrlScheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Scheme) :: S1 (MetaSel (Just "baseUrlHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :: (S1 (MetaSel (Just "baseUrlPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "baseUrlPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

data Scheme Source #

URI scheme to use

Constructors

Http	http://
Https	https://

Instances

Eq Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods (==) :: Scheme -> Scheme -> Bool # (/=) :: Scheme -> Scheme -> Bool #
Data Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Scheme -> c Scheme # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Scheme # toConstr :: Scheme -> Constr # dataTypeOf :: Scheme -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Scheme) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Scheme) # gmapT :: (forall b. Data b => b -> b) -> Scheme -> Scheme # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Scheme -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Scheme -> r # gmapQ :: (forall d. Data d => d -> u) -> Scheme -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Scheme -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Scheme -> m Scheme # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Scheme -> m Scheme # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Scheme -> m Scheme #
Ord Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods compare :: Scheme -> Scheme -> Ordering # (<) :: Scheme -> Scheme -> Bool # (<=) :: Scheme -> Scheme -> Bool # (>) :: Scheme -> Scheme -> Bool # (>=) :: Scheme -> Scheme -> Bool # max :: Scheme -> Scheme -> Scheme # min :: Scheme -> Scheme -> Scheme #
Show Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods showsPrec :: Int -> Scheme -> ShowS # show :: Scheme -> String # showList :: [Scheme] -> ShowS #
Generic Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Associated Types type Rep Scheme :: Type -> Type # Methods from :: Scheme -> Rep Scheme x # to :: Rep Scheme x -> Scheme #
Lift Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods lift :: Scheme -> Q Exp #
type Rep Scheme Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl type Rep Scheme = D1 (MetaData "Scheme" "Servant.Client.Core.Internal.BaseUrl" "servant-client-core-0.15-BELfpAH4M6qDJZvAfR1UCC" False) (C1 (MetaCons "Http" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Https" PrefixI False) (U1 :: Type -> Type))

showBaseUrl :: BaseUrl -> String Source #

>>> showBaseUrl <$> parseBaseUrl "api.example.com"
"http://api.example.com"

parseBaseUrl :: MonadThrow m => String -> m BaseUrl Source #

>>> parseBaseUrl "api.example.com"
BaseUrl {baseUrlScheme = Http, baseUrlHost = "api.example.com", baseUrlPort = 80, baseUrlPath = ""}

Note: trailing slash is removed

>>> parseBaseUrl "api.example.com/"
BaseUrl {baseUrlScheme = Http, baseUrlHost = "api.example.com", baseUrlPort = 80, baseUrlPath = ""}

>>> parseBaseUrl "api.example.com/dir/"
BaseUrl {baseUrlScheme = Http, baseUrlHost = "api.example.com", baseUrlPort = 80, baseUrlPath = "/dir"}

data InvalidBaseUrlException Source #

Instances

Show InvalidBaseUrlException Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods showsPrec :: Int -> InvalidBaseUrlException -> ShowS # show :: InvalidBaseUrlException -> String # showList :: [InvalidBaseUrlException] -> ShowS #
Exception InvalidBaseUrlException Source #
Instance details Defined in Servant.Client.Core.Internal.BaseUrl Methods toException :: InvalidBaseUrlException -> SomeException # fromException :: SomeException -> Maybe InvalidBaseUrlException # displayException :: InvalidBaseUrlException -> String #

HasClient

Response (for Raw)

Generic Client

BaseUrl

Response (for `Raw`)