Servant.Client.Core.Reexport

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.

HasClient

class RunClient m => HasClient m api where

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.

Minimal complete definition

clientWithRoute, hoistClientMonad

Associated Types

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

Methods

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

Instances

RunClient m => HasClient m Raw

Pick a Method and specify where the server you want to query is. You get back the full Response.

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m Raw :: *

Methods

clientWithRoute :: Proxy m -> Proxy Raw -> Request -> Client m Raw

hoistClientMonad :: Proxy m -> Proxy Raw -> (forall x. mon x -> mon' x) -> Client mon Raw -> Client mon' Raw

RunClient m => HasClient m EmptyAPI

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m EmptyAPI :: *

Methods

clientWithRoute :: Proxy m -> Proxy EmptyAPI -> Request -> Client m EmptyAPI

hoistClientMonad :: Proxy m -> Proxy EmptyAPI -> (forall x. mon x -> mon' x) -> Client mon EmptyAPI -> Client mon' EmptyAPI

(HasClient m a, HasClient m b) => HasClient m (a :<|> b)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (a :<|> b) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (a :<|> b) -> Request -> Client m (a :<|> b)

hoistClientMonad :: Proxy m -> Proxy (a :<|> b) -> (forall x. mon x -> mon' x) -> Client mon (a :<|> b) -> Client mon' (a :<|> b)

HasClient m api => HasClient m (BasicAuth realm usr :> api)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (BasicAuth realm usr :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (BasicAuth realm usr :> api) -> Request -> Client m (BasicAuth realm usr :> api)

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)

HasClient m api => HasClient m (AuthProtect tag :> api)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (AuthProtect tag :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (AuthProtect tag :> api) -> Request -> Client m (AuthProtect tag :> api)

hoistClientMonad :: Proxy m -> Proxy (AuthProtect tag :> api) -> (forall x. mon x -> mon' x) -> Client mon (AuthProtect tag :> api) -> Client mon' (AuthProtect tag :> api)

HasClient m subapi => HasClient m (WithNamedContext name context subapi)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (WithNamedContext name context subapi) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (WithNamedContext name context subapi) -> Request -> Client m (WithNamedContext name context subapi)

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)

HasClient m api => HasClient m (IsSecure :> api)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (IsSecure :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (IsSecure :> api) -> Request -> Client m (IsSecure :> api)

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

HasClient m api => HasClient m (RemoteHost :> api)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (RemoteHost :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (RemoteHost :> api) -> Request -> Client m (RemoteHost :> api)

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

HasClient m api => HasClient m (Vault :> api)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Vault :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Vault :> api) -> Request -> Client m (Vault :> api)

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

(KnownSymbol path, HasClient m api) => HasClient m (path :> api)

Make the querying function append path to the request path.

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (path :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (path :> api) -> Request -> Client m (path :> api)

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

(MimeRender ct a, HasClient m api) => HasClient m (ReqBody' mods (ct ': cts) a :> api)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (ReqBody' mods (ct ': cts) a :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (ReqBody' mods (ct ': cts) a :> api) -> Request -> Client m (ReqBody' mods (ct ': cts) a :> api)

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)

(KnownSymbol sym, HasClient m api) => HasClient m (QueryFlag sym :> api)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (QueryFlag sym :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (QueryFlag sym :> api) -> Request -> Client m (QueryFlag sym :> api)

hoistClientMonad :: Proxy m -> Proxy (QueryFlag sym :> api) -> (forall x. mon x -> mon' x) -> Client mon (QueryFlag sym :> api) -> Client mon' (QueryFlag sym :> api)

(KnownSymbol sym, ToHttpApiData a, HasClient m api) => HasClient m (QueryParams sym a :> api)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (QueryParams sym a :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (QueryParams sym a :> api) -> Request -> Client m (QueryParams sym a :> api)

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)

(KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequired mods)) => HasClient m (QueryParam' mods sym a :> api)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (QueryParam' mods sym a :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (QueryParam' mods sym a :> api) -> Request -> Client m (QueryParam' mods sym a :> api)

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)

HasClient m api => HasClient m (Description desc :> api)

Ignore Description in client functions.

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Description desc :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Description desc :> api) -> Request -> Client m (Description desc :> api)

hoistClientMonad :: Proxy m -> Proxy (Description desc :> api) -> (forall x. mon x -> mon' x) -> Client mon (Description desc :> api) -> Client mon' (Description desc :> api)

HasClient m api => HasClient m (Summary desc :> api)

Ignore Summary in client functions.

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Summary desc :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Summary desc :> api) -> Request -> Client m (Summary desc :> api)

hoistClientMonad :: Proxy m -> Proxy (Summary desc :> api) -> (forall x. mon x -> mon' x) -> Client mon (Summary desc :> api) -> Client mon' (Summary desc :> api)

HasClient m api => HasClient m (HttpVersion :> api)

Using a HttpVersion combinator in your API doesn't affect the client functions.

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (HttpVersion :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (HttpVersion :> api) -> Request -> Client m (HttpVersion :> api)

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

(KnownSymbol sym, ToHttpApiData a, HasClient m api, SBoolI (FoldRequired mods)) => HasClient m (Header' mods sym a :> api)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Header' mods sym a :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Header' mods sym a :> api) -> Request -> Client m (Header' mods sym a :> api)

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)

(KnownSymbol capture, ToHttpApiData a, HasClient m sublayout) => HasClient m (CaptureAll capture a :> sublayout)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (CaptureAll capture a :> sublayout) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (CaptureAll capture a :> sublayout) -> Request -> Client m (CaptureAll capture a :> sublayout)

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)

(KnownSymbol capture, ToHttpApiData a, HasClient m api) => HasClient m (Capture' mods capture a :> api)

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

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Capture' mods capture a :> api) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Capture' mods capture a :> api) -> Request -> Client m (Capture' mods capture a :> api)

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)

(RunClient m, BuildHeadersTo ls, ReflectMethod method) => HasClient m (Verb method status cts (Headers ls NoContent))

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Verb method status cts (Headers ls NoContent)) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Verb method status cts (Headers ls NoContent)) -> Request -> Client m (Verb method status cts (Headers ls NoContent))

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))

(RunClient m, MimeUnrender ct a, BuildHeadersTo ls, ReflectMethod method, cts' ~ (ct ': cts)) => HasClient m (Verb method status cts' (Headers ls a))

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Verb method status cts' (Headers ls a)) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Verb method status cts' (Headers ls a)) -> Request -> Client m (Verb method status cts' (Headers ls a))

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))

(RunClient m, ReflectMethod method) => HasClient m (Verb method status cts NoContent)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Verb method status cts NoContent) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Verb method status cts NoContent) -> Request -> Client m (Verb method status cts NoContent)

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)

(RunClient m, MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts)) => HasClient m (Verb method status cts' a)

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Verb method status cts' a) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Verb method status cts' a) -> Request -> Client m (Verb method status cts' a)

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)

(RunClient m, MimeUnrender ct a, ReflectMethod method, FramingUnrender framing a, BuildFromStream a (f a)) => HasClient m (Stream method status framing ct (f a))

Defined in Servant.Client.Core.Internal.HasClient

Associated Types

type Client m (Stream method status framing ct (f a)) :: *

Methods

clientWithRoute :: Proxy m -> Proxy (Stream method status framing ct (f a)) -> Request -> Client m (Stream method status framing ct (f a))

hoistClientMonad :: Proxy m -> Proxy (Stream method status framing ct (f a)) -> (forall x. mon x -> mon' x) -> Client mon (Stream method status framing ct (f a)) -> Client mon' (Stream method status framing ct (f a))

Response (for Raw)

type Response = GenResponse ByteString

data StreamingResponse

data GenResponse a

Constructors

Response

Fields

• responseStatusCode :: Status
• responseHeaders :: Seq Header
• responseHttpVersion :: HttpVersion
• responseBody :: a

Instances

Functor GenResponse

Defined in Servant.Client.Core.Internal.Request

Methods

fmap :: (a -> b) -> GenResponse a -> GenResponse b

(<$) :: a -> GenResponse b -> GenResponse a

Foldable GenResponse

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

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)

Defined in Servant.Client.Core.Internal.Request

Methods

(==) :: GenResponse a -> GenResponse a -> Bool

(/=) :: GenResponse a -> GenResponse a -> Bool

Show a => Show (GenResponse a)

Defined in Servant.Client.Core.Internal.Request

Methods

showsPrec :: Int -> GenResponse a -> ShowS

show :: GenResponse a -> String

showList :: [GenResponse a] -> ShowS

Generic (GenResponse a)

Defined in Servant.Client.Core.Internal.Request

Associated Types

type Rep (GenResponse a) :: * -> *

Methods

from :: GenResponse a -> Rep (GenResponse a) x

to :: Rep (GenResponse a) x -> GenResponse a

type Rep (GenResponse a)

Defined in Servant.Client.Core.Internal.Request

type Rep (GenResponse a) = D1 (MetaData "GenResponse" "Servant.Client.Core.Internal.Request" "servant-client-core-0.14.1-FKnmINyAR8AHPAf2gxjsat" 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

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))

Methods

mkClient :: client -> custom

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

Instances

ClientLike client custom => ClientLike (a -> client) (a -> custom)

Defined in Servant.Client.Core.Internal.Generic

Methods

mkClient :: (a -> client) -> a -> custom

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

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

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

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

data ServantError

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

Defined in Servant.Client.Core.Internal.Request

Methods

(==) :: ServantError -> ServantError -> Bool

(/=) :: ServantError -> ServantError -> Bool

Show ServantError

Defined in Servant.Client.Core.Internal.Request

Methods

showsPrec :: Int -> ServantError -> ShowS

show :: ServantError -> String

showList :: [ServantError] -> ShowS

Generic ServantError

Defined in Servant.Client.Core.Internal.Request

Associated Types

type Rep ServantError :: * -> *

Methods

from :: ServantError -> Rep ServantError x

to :: Rep ServantError x -> ServantError

Exception ServantError

Defined in Servant.Client.Core.Internal.Request

Methods

toException :: ServantError -> SomeException

fromException :: SomeException -> Maybe ServantError

displayException :: ServantError -> String

type Rep ServantError

Defined in Servant.Client.Core.Internal.Request

type Rep ServantError = D1 (MetaData "ServantError" "Servant.Client.Core.Internal.Request" "servant-client-core-0.14.1-FKnmINyAR8AHPAf2gxjsat" 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

Singleton type representing a client for an empty API.

Constructors

EmptyClient

Instances

Bounded EmptyClient

Defined in Servant.Client.Core.Internal.HasClient

Methods

minBound :: EmptyClient

maxBound :: EmptyClient

Enum EmptyClient

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

Defined in Servant.Client.Core.Internal.HasClient

Methods

(==) :: EmptyClient -> EmptyClient -> Bool

(/=) :: EmptyClient -> EmptyClient -> Bool

Show EmptyClient

Defined in Servant.Client.Core.Internal.HasClient

Methods

showsPrec :: Int -> EmptyClient -> ShowS

show :: EmptyClient -> String

showList :: [EmptyClient] -> ShowS

BaseUrl

data BaseUrl

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

Defined in Servant.Client.Core.Internal.BaseUrl

Methods

(==) :: BaseUrl -> BaseUrl -> Bool

(/=) :: BaseUrl -> BaseUrl -> Bool

Ord BaseUrl

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

Defined in Servant.Client.Core.Internal.BaseUrl

Methods

showsPrec :: Int -> BaseUrl -> ShowS

show :: BaseUrl -> String

showList :: [BaseUrl] -> ShowS

Generic BaseUrl

Defined in Servant.Client.Core.Internal.BaseUrl

Associated Types

type Rep BaseUrl :: * -> *

Methods

from :: BaseUrl -> Rep BaseUrl x

to :: Rep BaseUrl x -> BaseUrl

type Rep BaseUrl

Defined in Servant.Client.Core.Internal.BaseUrl

type Rep BaseUrl = D1 (MetaData "BaseUrl" "Servant.Client.Core.Internal.BaseUrl" "servant-client-core-0.14.1-FKnmINyAR8AHPAf2gxjsat" 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

URI scheme to use

Constructors

Http

http://

Https

https://

Instances

Eq Scheme

Defined in Servant.Client.Core.Internal.BaseUrl

Methods

(==) :: Scheme -> Scheme -> Bool

(/=) :: Scheme -> Scheme -> Bool

Ord Scheme

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

Defined in Servant.Client.Core.Internal.BaseUrl

Methods

showsPrec :: Int -> Scheme -> ShowS

show :: Scheme -> String

showList :: [Scheme] -> ShowS

Generic Scheme

Defined in Servant.Client.Core.Internal.BaseUrl

Associated Types

type Rep Scheme :: * -> *

Methods

from :: Scheme -> Rep Scheme x

to :: Rep Scheme x -> Scheme

type Rep Scheme

Defined in Servant.Client.Core.Internal.BaseUrl

type Rep Scheme = D1 (MetaData "Scheme" "Servant.Client.Core.Internal.BaseUrl" "servant-client-core-0.14.1-FKnmINyAR8AHPAf2gxjsat" False) (C1 (MetaCons "Http" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Https" PrefixI False) (U1 :: * -> *))

showBaseUrl :: BaseUrl -> String

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

data InvalidBaseUrlException

Instances

Show InvalidBaseUrlException

Defined in Servant.Client.Core.Internal.BaseUrl

Methods

showsPrec :: Int -> InvalidBaseUrlException -> ShowS

show :: InvalidBaseUrlException -> String

showList :: [InvalidBaseUrlException] -> ShowS

Exception InvalidBaseUrlException

Defined in Servant.Client.Core.Internal.BaseUrl

Methods

toException :: InvalidBaseUrlException -> SomeException

fromException :: SomeException -> Maybe InvalidBaseUrlException

displayException :: InvalidBaseUrlException -> String