servant-client-core-0.19: Core functionality and class for client function generation for servant APIs
Safe Haskell None
Language Haskell2010

Servant.Client.Core

Description

This module provides backend-agnostic functionality for generating clients from servant APIs. By "backend," we mean something that concretely executes the request, such as:

  • The http-client library
  • The haxl library
  • GHCJS via FFI

etc.

Each backend is encapsulated in a monad that is an instance of the RunClient class.

This library is primarily of interest to backend-writers and combinator-writers. For more information, see the README.md

Synopsis

Client generation

clientIn :: HasClient m api => Proxy api -> Proxy m -> Client m api Source #

clientIn allows you to produce operations to query an API from a client within a RunClient monad. 

type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
        :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books

myApi :: Proxy MyApi
myApi = Proxy

clientM :: Proxy ClientM
clientM = Proxy

getAllBooks :: ClientM [Book]
postNewBook :: Book -> ClientM Book
(getAllBooks :<|> postNewBook) = myApi `clientIn` clientM

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

Instances details
( RunClient m, TypeError ( NoInstanceFor ( HasClient m api)) :: Constraint ) => HasClient m api Source #
Instance details

Defined in Servant.Client.Core.HasClient

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 #

RunClient m => HasClient m Raw Source #

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

Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m Raw 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.HasClient

Associated Types

type Client m EmptyAPI 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 #

( forall (n :: Type -> Type ). GClient api n, HasClient m ( ToServantApi api), RunClient m) => HasClient m ( NamedRoutes api) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( NamedRoutes api) Source #

Methods

clientWithRoute :: Proxy m -> Proxy ( NamedRoutes api) -> Request -> Client m ( NamedRoutes api) Source #

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

( RunClient m, ReflectMethod method) => HasClient m ( NoContentVerb method) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( NoContentVerb method) Source #

Methods

clientWithRoute :: Proxy m -> Proxy ( NoContentVerb method) -> Request -> Client m ( NoContentVerb method) Source #

hoistClientMonad :: Proxy m -> Proxy ( NoContentVerb method) -> ( forall x. mon x -> mon' x) -> Client mon ( NoContentVerb method) -> Client mon' ( NoContentVerb method) 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.HasClient

Associated Types

type Client m (a :<|> b) 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 #

( RunClient m, TypeError ( NoInstanceForSub ( HasClient m) ty) :: Constraint ) => HasClient m (ty :> sub) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m (ty :> sub) Source #

Methods

clientWithRoute :: Proxy m -> Proxy (ty :> sub) -> Request -> Client m (ty :> sub) Source #

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

( RunClient m, TypeError ( PartialApplication HasClient arr) :: Constraint ) => HasClient m (arr :> sub) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m (arr :> sub) Source #

Methods

clientWithRoute :: Proxy m -> Proxy (arr :> sub) -> Request -> Client m (arr :> sub) Source #

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

HasClient m api => HasClient m ( BasicAuth realm usr :> api) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( BasicAuth realm usr :> api) 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 #

( AtLeastOneFragment api, FragmentUnique ( Fragment a :> api), HasClient m api) => HasClient m ( Fragment a :> api) Source #

Ignore Fragment in client functions. See https://ietf.org/rfc/rfc2616.html#section-15.1.3 for more details.

Example: 

type MyApi = "books" :> Fragment Text :> Get '[JSON] [Book]

myApi :: Proxy MyApi
myApi = Proxy

getBooks :: ClientM [Book]
getBooks = client myApi
-- then you can just use "getBooksBy" to query that endpoint.
-- 'getBooks' for all books.
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( Fragment a :> api) Source #

Methods

clientWithRoute :: Proxy m -> Proxy ( Fragment a :> api) -> Request -> Client m ( Fragment a :> api) Source #

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

HasClient m api => HasClient m ( AuthProtect tag :> api) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( AuthProtect tag :> api) 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.HasClient

Associated Types

type Client m ( WithNamedContext name context subapi) 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.HasClient

Associated Types

type Client m ( IsSecure :> api) 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.HasClient

Associated Types

type Client m ( RemoteHost :> api) 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.HasClient

Associated Types

type Client m ( Vault :> api) 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.HasClient

Associated Types

type Client m (path :> api) 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, MimeRender ctype chunk, FramingRender framing, ToSourceIO chunk a) => HasClient m ( StreamBody' mods framing ctype a :> api) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( StreamBody' mods framing ctype a :> api) 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.HasClient

Associated Types

type Client m ( ReqBody' mods (ct ': cts) a :> api) 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.HasClient

Associated Types

type Client m ( QueryFlag sym :> api) 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.HasClient

Associated Types

type Client m ( QueryParams sym a :> api) 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.HasClient

Associated Types

type Client m ( QueryParam' mods sym a :> api) 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.HasClient

Associated Types

type Client m ( Description desc :> api) 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.HasClient

Associated Types

type Client m ( Summary desc :> api) 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.HasClient

Associated Types

type Client m ( HttpVersion :> api) 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.HasClient

Associated Types

type Client m ( Header' mods sym a :> api) 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 #

( RunClient m, contentTypes ~ (contentType ': otherContentTypes), as ~ (a ': as'), AllMime contentTypes, ReflectMethod method, All (UnrenderResponse contentTypes) as, All HasStatus as, HasStatuses as', Unique ( Statuses as)) => HasClient m ( UVerb method contentTypes as) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( UVerb method contentTypes as) Source #

Methods

clientWithRoute :: Proxy m -> Proxy ( UVerb method contentTypes as) -> Request -> Client m ( UVerb method contentTypes as) Source #

hoistClientMonad :: Proxy m -> Proxy ( UVerb method contentTypes as) -> ( forall x. mon x -> mon' x) -> Client mon ( UVerb method contentTypes as) -> Client mon' ( UVerb method contentTypes as) 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.HasClient

Associated Types

type Client m ( CaptureAll capture a :> sublayout) 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.HasClient

Associated Types

type Client m ( Capture' mods capture a :> api) 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, KnownNat status) => HasClient m ( Verb method status cts ( Headers ls NoContent )) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( Verb method status cts ( Headers ls NoContent )) 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, KnownNat status, ReflectMethod method, cts' ~ (ct ': cts)) => HasClient m ( Verb method status cts' ( Headers ls a)) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( Verb method status cts' ( Headers ls a)) 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, KnownNat status) => HasClient m ( Verb method status cts NoContent ) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( Verb method status cts NoContent ) 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), KnownNat status) => HasClient m ( Verb method status cts' a) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( Verb method status cts' a) 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, BuildHeadersTo hs) => HasClient m ( Stream method status framing ct ( Headers hs a)) Source #
Instance details

Defined in Servant.Client.Core.HasClient

Associated Types

type Client m ( Stream method status framing ct ( Headers hs a)) Source #

Methods

clientWithRoute :: Proxy m -> Proxy ( Stream method status framing ct ( Headers hs a)) -> Request -> Client m ( Stream method status framing ct ( Headers hs a)) Source #

hoistClientMonad :: Proxy m -> Proxy ( Stream method status framing ct ( Headers hs a)) -> ( forall x. mon x -> mon' x) -> Client mon ( Stream method status framing ct ( Headers hs a)) -> Client mon' ( Stream method status framing ct ( Headers hs 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.HasClient

Associated Types

type Client m ( Stream method status framing ct a) 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 #

foldMapUnion :: forall c a (as :: [ Type ]). All c as => Proxy c -> ( forall x. c x => x -> a) -> Union as -> a Source #

Convenience function to apply a function to an unknown union element using a type class. All elements of the union must have instances in the type class, and the function is applied unconditionally.

See also: matchUnion .

matchUnion :: forall a (as :: [ Type ]). IsMember a as => Union as -> Maybe a Source #

Convenience function to extract a union element using cast , ie. return the value if the selected type happens to be the actual type of the union in this value, or Nothing otherwise.

See also: foldMapUnion .

Request

type Request = RequestF RequestBody Builder Source #

data RequestF body path Source #

Constructors

Request

Fields

Instances

Instances details
Bifunctor RequestF Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

bimap :: (a -> b) -> (c -> d) -> RequestF a c -> RequestF b d Source #

first :: (a -> b) -> RequestF a c -> RequestF b c Source #

second :: (b -> c) -> RequestF a b -> RequestF a c Source #

Bitraversable RequestF Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

bitraverse :: Applicative f => (a -> f c) -> (b -> f d) -> RequestF a b -> f ( RequestF c d) Source #

Bifoldable RequestF Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

bifold :: Monoid m => RequestF m m -> m Source #

bifoldMap :: Monoid m => (a -> m) -> (b -> m) -> RequestF a b -> m Source #

bifoldr :: (a -> c -> c) -> (b -> c -> c) -> c -> RequestF a b -> c Source #

bifoldl :: (c -> a -> c) -> (c -> b -> c) -> c -> RequestF a b -> c Source #

Functor ( RequestF body) Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

fmap :: (a -> b) -> RequestF body a -> RequestF body b Source #

(<$) :: a -> RequestF body b -> RequestF body a Source #

Foldable ( RequestF body) Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

fold :: Monoid m => RequestF body m -> m Source #

foldMap :: Monoid m => (a -> m) -> RequestF body a -> m Source #

foldMap' :: Monoid m => (a -> m) -> RequestF body a -> m Source #

foldr :: (a -> b -> b) -> b -> RequestF body a -> b Source #

foldr' :: (a -> b -> b) -> b -> RequestF body a -> b Source #

foldl :: (b -> a -> b) -> b -> RequestF body a -> b Source #

foldl' :: (b -> a -> b) -> b -> RequestF body a -> b Source #

foldr1 :: (a -> a -> a) -> RequestF body a -> a Source #

foldl1 :: (a -> a -> a) -> RequestF body a -> a Source #

toList :: RequestF body a -> [a] Source #

null :: RequestF body a -> Bool Source #

length :: RequestF body a -> Int Source #

elem :: Eq a => a -> RequestF body a -> Bool Source #

maximum :: Ord a => RequestF body a -> a Source #

minimum :: Ord a => RequestF body a -> a Source #

sum :: Num a => RequestF body a -> a Source #

product :: Num a => RequestF body a -> a Source #

Traversable ( RequestF body) Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

traverse :: Applicative f => (a -> f b) -> RequestF body a -> f ( RequestF body b) Source #

sequenceA :: Applicative f => RequestF body (f a) -> f ( RequestF body a) Source #

mapM :: Monad m => (a -> m b) -> RequestF body a -> m ( RequestF body b) Source #

sequence :: Monad m => RequestF body (m a) -> m ( RequestF body a) Source #

( Eq path, Eq body) => Eq ( RequestF body path) Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

(==) :: RequestF body path -> RequestF body path -> Bool Source #

(/=) :: RequestF body path -> RequestF body path -> Bool Source #

( Show a, Show b) => Show ( RequestF a b) Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

showsPrec :: Int -> RequestF a b -> ShowS Source #

show :: RequestF a b -> String Source #

showList :: [ RequestF a b] -> ShowS Source #

Generic ( RequestF body path) Source #
Instance details

Defined in Servant.Client.Core.Request

Associated Types

type Rep ( RequestF body path) :: Type -> Type Source #

Methods

from :: RequestF body path -> Rep ( RequestF body path) x Source #

to :: Rep ( RequestF body path) x -> RequestF body path Source #

( NFData path, NFData body) => NFData ( RequestF body path) Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

rnf :: RequestF body path -> () Source #

type Rep ( RequestF body path) Source #
Instance details

Defined in Servant.Client.Core.Request

type Rep ( RequestF body path) = D1 (' MetaData "RequestF" "Servant.Client.Core.Request" "servant-client-core-0.19-DAS79QGMO4DL64AFO0JBqz" ' False ) ( C1 (' MetaCons "Request" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "requestPath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 path) :*: ( S1 (' MetaSel (' Just "requestQueryString") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Seq QueryItem )) :*: S1 (' MetaSel (' Just "requestBody") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe (body, MediaType ))))) :*: (( S1 (' MetaSel (' Just "requestAccept") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Seq MediaType )) :*: S1 (' MetaSel (' Just "requestHeaders") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Seq Header ))) :*: ( S1 (' MetaSel (' Just "requestHttpVersion") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 HttpVersion ) :*: S1 (' MetaSel (' Just "requestMethod") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Method )))))

defaultRequest :: Request Source #

data RequestBody Source #

The request body. R replica of the http-client RequestBody .

Constructors

RequestBodyLBS ByteString
RequestBodyBS ByteString
RequestBodySource ( SourceIO ByteString )

Instances

Instances details
Show RequestBody Source #
Instance details

Defined in Servant.Client.Core.Request

Methods

showsPrec :: Int -> RequestBody -> ShowS Source #

show :: RequestBody -> String Source #

showList :: [ RequestBody ] -> ShowS Source #

Generic RequestBody Source #
Instance details

Defined in Servant.Client.Core.Request

Associated Types

type Rep RequestBody :: Type -> Type Source #

Methods

from :: RequestBody -> Rep RequestBody x Source #

to :: Rep RequestBody x -> RequestBody Source #

type Rep RequestBody Source #
Instance details

Defined in Servant.Client.Core.Request

type Rep RequestBody = D1 (' MetaData "RequestBody" "Servant.Client.Core.Request" "servant-client-core-0.19-DAS79QGMO4DL64AFO0JBqz" ' False ) ( C1 (' MetaCons "RequestBodyLBS" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )) :+: ( C1 (' MetaCons "RequestBodyBS" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )) :+: C1 (' MetaCons "RequestBodySource" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( SourceIO ByteString )))))

Authentication

mkAuthenticatedRequest :: AuthClientData a -> ( AuthClientData a -> Request -> Request ) -> AuthenticatedRequest a Source #

Handy helper to avoid wrapping datatypes in tuples everywhere.

NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

basicAuthReq :: BasicAuthData -> Request -> Request Source #

Authenticate a request using Basic Authentication

newtype AuthenticatedRequest a Source #

For better type inference and to avoid usage of a data family, we newtype wrap the combination of some AuthClientData and a function to add authentication data to a request

NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

Constructors

AuthenticatedRequest

Fields

type family AuthClientData a :: * Source #

For a resource protected by authentication (e.g. AuthProtect), we need to provide the client with some data used to add authentication data to a request

NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

Generic Client

data ClientError Source #

A type representing possible errors in a request

Note that this type substantially changed in 0.12.

Constructors

FailureResponse ( RequestF () ( BaseUrl , ByteString )) Response

The server returned an error response including the failing request. requestPath includes the BaseUrl and the path of the request.

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 SomeException

There was a connection error, and no response was received

Instances

Instances details
Eq ClientError Source #
Instance details

Defined in Servant.Client.Core.ClientError

Methods

(==) :: ClientError -> ClientError -> Bool Source #

(/=) :: ClientError -> ClientError -> Bool Source #

Show ClientError Source #
Instance details

Defined in Servant.Client.Core.ClientError

Methods

showsPrec :: Int -> ClientError -> ShowS Source #

show :: ClientError -> String Source #

showList :: [ ClientError ] -> ShowS Source #

Generic ClientError Source #
Instance details

Defined in Servant.Client.Core.ClientError

Associated Types

type Rep ClientError :: Type -> Type Source #

Methods

from :: ClientError -> Rep ClientError x Source #

to :: Rep ClientError x -> ClientError Source #

Exception ClientError Source #
Instance details

Defined in Servant.Client.Core.ClientError

Methods

toException :: ClientError -> SomeException Source #

fromException :: SomeException -> Maybe ClientError Source #

displayException :: ClientError -> String Source #

NFData ClientError Source #

Note: an exception in ConnectionError might not be evaluated fully, We only rnf its show ed value.

Instance details

Defined in Servant.Client.Core.ClientError

Methods

rnf :: ClientError -> () Source #

type Rep ClientError Source #
Instance details

Defined in Servant.Client.Core.ClientError

type Rep ClientError = D1 (' MetaData "ClientError" "Servant.Client.Core.ClientError" "servant-client-core-0.19-DAS79QGMO4DL64AFO0JBqz" ' False ) (( C1 (' MetaCons "FailureResponse" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( RequestF () ( BaseUrl , ByteString ))) :*: 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 SomeException )))))

data EmptyClient Source #

Singleton type representing a client for an empty API.

Constructors

EmptyClient

Instances

Instances details
Bounded EmptyClient Source #
Instance details

Defined in Servant.Client.Core.HasClient

Methods

minBound :: EmptyClient Source #

maxBound :: EmptyClient Source #

Enum EmptyClient Source #
Instance details

Defined in Servant.Client.Core.HasClient

Methods

succ :: EmptyClient -> EmptyClient Source #

pred :: EmptyClient -> EmptyClient Source #

toEnum :: Int -> EmptyClient Source #

fromEnum :: EmptyClient -> Int Source #

enumFrom :: EmptyClient -> [ EmptyClient ] Source #

enumFromThen :: EmptyClient -> EmptyClient -> [ EmptyClient ] Source #

enumFromTo :: EmptyClient -> EmptyClient -> [ EmptyClient ] Source #

enumFromThenTo :: EmptyClient -> EmptyClient -> EmptyClient -> [ EmptyClient ] Source #

Eq EmptyClient Source #
Instance details

Defined in Servant.Client.Core.HasClient

Methods

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

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

Show EmptyClient Source #
Instance details

Defined in Servant.Client.Core.HasClient

Methods

showsPrec :: Int -> EmptyClient -> ShowS Source #

show :: EmptyClient -> String Source #

showList :: [ EmptyClient ] -> ShowS Source #

Response

type Response = ResponseF ByteString Source #

data ResponseF a Source #

Constructors

Response

Fields

Instances

Instances details
Functor ResponseF Source #
Instance details

Defined in Servant.Client.Core.Response

Methods

fmap :: (a -> b) -> ResponseF a -> ResponseF b Source #

(<$) :: a -> ResponseF b -> ResponseF a Source #

Foldable ResponseF Source #
Instance details

Defined in Servant.Client.Core.Response

Methods

fold :: Monoid m => ResponseF m -> m Source #

foldMap :: Monoid m => (a -> m) -> ResponseF a -> m Source #

foldMap' :: Monoid m => (a -> m) -> ResponseF a -> m Source #

foldr :: (a -> b -> b) -> b -> ResponseF a -> b Source #

foldr' :: (a -> b -> b) -> b -> ResponseF a -> b Source #

foldl :: (b -> a -> b) -> b -> ResponseF a -> b Source #

foldl' :: (b -> a -> b) -> b -> ResponseF a -> b Source #

foldr1 :: (a -> a -> a) -> ResponseF a -> a Source #

foldl1 :: (a -> a -> a) -> ResponseF a -> a Source #

toList :: ResponseF a -> [a] Source #

null :: ResponseF a -> Bool Source #

length :: ResponseF a -> Int Source #

elem :: Eq a => a -> ResponseF a -> Bool Source #

maximum :: Ord a => ResponseF a -> a Source #

minimum :: Ord a => ResponseF a -> a Source #

sum :: Num a => ResponseF a -> a Source #

product :: Num a => ResponseF a -> a Source #

Traversable ResponseF Source #
Instance details

Defined in Servant.Client.Core.Response

Methods

traverse :: Applicative f => (a -> f b) -> ResponseF a -> f ( ResponseF b) Source #

sequenceA :: Applicative f => ResponseF (f a) -> f ( ResponseF a) Source #

mapM :: Monad m => (a -> m b) -> ResponseF a -> m ( ResponseF b) Source #

sequence :: Monad m => ResponseF (m a) -> m ( ResponseF a) Source #

Eq a => Eq ( ResponseF a) Source #
Instance details

Defined in Servant.Client.Core.Response

Methods

(==) :: ResponseF a -> ResponseF a -> Bool Source #

(/=) :: ResponseF a -> ResponseF a -> Bool Source #

Show a => Show ( ResponseF a) Source #
Instance details

Defined in Servant.Client.Core.Response

Methods

showsPrec :: Int -> ResponseF a -> ShowS Source #

show :: ResponseF a -> String Source #

showList :: [ ResponseF a] -> ShowS Source #

Generic ( ResponseF a) Source #
Instance details

Defined in Servant.Client.Core.Response

Associated Types

type Rep ( ResponseF a) :: Type -> Type Source #

Methods

from :: ResponseF a -> Rep ( ResponseF a) x Source #

to :: Rep ( ResponseF a) x -> ResponseF a Source #

NFData a => NFData ( ResponseF a) Source #
Instance details

Defined in Servant.Client.Core.Response

Methods

rnf :: ResponseF a -> () Source #

type Rep ( ResponseF a) Source #
Instance details

Defined in Servant.Client.Core.Response

type Rep ( ResponseF a) = D1 (' MetaData "ResponseF" "Servant.Client.Core.Response" "servant-client-core-0.19-DAS79QGMO4DL64AFO0JBqz" ' 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))))

class Monad m => RunClient m where Source #

Methods

runRequestAcceptStatus :: Maybe [ Status ] -> Request -> m Response Source #

How to make a request, with an optional list of status codes to not throw exceptions for (default: [200..299]).

throwClientError :: ClientError -> m a Source #

Instances

Instances details
ClientF ~ f => RunClient ( Free f) Source #
Instance details

Defined in Servant.Client.Core.RunClient

Methods

runRequestAcceptStatus :: Maybe [ Status ] -> Request -> Free f Response Source #

throwClientError :: ClientError -> Free f a Source #

BaseUrl

data BaseUrl Source #

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

Constructors

BaseUrl

Fields

Instances

Instances details
Eq BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

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

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

Data BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> BaseUrl -> c BaseUrl Source #

gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c BaseUrl Source #

toConstr :: BaseUrl -> Constr Source #

dataTypeOf :: BaseUrl -> DataType Source #

dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c BaseUrl ) Source #

dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c BaseUrl ) Source #

gmapT :: ( forall b. Data b => b -> b) -> BaseUrl -> BaseUrl Source #

gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> BaseUrl -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> BaseUrl -> r Source #

gmapQ :: ( forall d. Data d => d -> u) -> BaseUrl -> [u] Source #

gmapQi :: Int -> ( forall d. Data d => d -> u) -> BaseUrl -> u Source #

gmapM :: Monad m => ( forall d. Data d => d -> m d) -> BaseUrl -> m BaseUrl Source #

gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> BaseUrl -> m BaseUrl Source #

gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> BaseUrl -> m BaseUrl Source #

Ord BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

compare :: BaseUrl -> BaseUrl -> Ordering Source #

(<) :: BaseUrl -> BaseUrl -> Bool Source #

(<=) :: BaseUrl -> BaseUrl -> Bool Source #

(>) :: BaseUrl -> BaseUrl -> Bool Source #

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

max :: BaseUrl -> BaseUrl -> BaseUrl Source #

min :: BaseUrl -> BaseUrl -> BaseUrl Source #

Show BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

showsPrec :: Int -> BaseUrl -> ShowS Source #

show :: BaseUrl -> String Source #

showList :: [ BaseUrl ] -> ShowS Source #

Generic BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Associated Types

type Rep BaseUrl :: Type -> Type Source #

Methods

from :: BaseUrl -> Rep BaseUrl x Source #

to :: Rep BaseUrl x -> BaseUrl Source #

ToJSON BaseUrl Source # 
>>> traverse_ (LBS8.putStrLn . encode) $ parseBaseUrl "api.example.com"
"http://api.example.com"
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

toJSON :: BaseUrl -> Value Source #

toEncoding :: BaseUrl -> Encoding Source #

toJSONList :: [ BaseUrl ] -> Value Source #

toEncodingList :: [ BaseUrl ] -> Encoding Source #

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.BaseUrl

Methods

toJSONKey :: ToJSONKeyFunction BaseUrl Source #

toJSONKeyList :: ToJSONKeyFunction [ BaseUrl ] Source #

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.BaseUrl

Methods

parseJSON :: Value -> Parser BaseUrl Source #

parseJSONList :: Value -> Parser [ BaseUrl ] Source #

FromJSONKey BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

fromJSONKey :: FromJSONKeyFunction BaseUrl Source #

fromJSONKeyList :: FromJSONKeyFunction [ BaseUrl ] Source #

NFData BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

rnf :: BaseUrl -> () Source #

Lift BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

lift :: BaseUrl -> Q Exp Source #

liftTyped :: BaseUrl -> Q ( TExp BaseUrl ) Source #

type Rep BaseUrl Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

type Rep BaseUrl = D1 (' MetaData "BaseUrl" "Servant.Client.Core.BaseUrl" "servant-client-core-0.19-DAS79QGMO4DL64AFO0JBqz" ' 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

Instances details
Eq Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

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

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

Data Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> Scheme -> c Scheme Source #

gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Scheme Source #

toConstr :: Scheme -> Constr Source #

dataTypeOf :: Scheme -> DataType Source #

dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Scheme ) Source #

dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Scheme ) Source #

gmapT :: ( forall b. Data b => b -> b) -> Scheme -> Scheme Source #

gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Scheme -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Scheme -> r Source #

gmapQ :: ( forall d. Data d => d -> u) -> Scheme -> [u] Source #

gmapQi :: Int -> ( forall d. Data d => d -> u) -> Scheme -> u Source #

gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Scheme -> m Scheme Source #

gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Scheme -> m Scheme Source #

gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Scheme -> m Scheme Source #

Ord Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

compare :: Scheme -> Scheme -> Ordering Source #

(<) :: Scheme -> Scheme -> Bool Source #

(<=) :: Scheme -> Scheme -> Bool Source #

(>) :: Scheme -> Scheme -> Bool Source #

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

max :: Scheme -> Scheme -> Scheme Source #

min :: Scheme -> Scheme -> Scheme Source #

Show Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

showsPrec :: Int -> Scheme -> ShowS Source #

show :: Scheme -> String Source #

showList :: [ Scheme ] -> ShowS Source #

Generic Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Associated Types

type Rep Scheme :: Type -> Type Source #

Methods

from :: Scheme -> Rep Scheme x Source #

to :: Rep Scheme x -> Scheme Source #

Lift Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

lift :: Scheme -> Q Exp Source #

liftTyped :: Scheme -> Q ( TExp Scheme ) Source #

type Rep Scheme Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

type Rep Scheme = D1 (' MetaData "Scheme" "Servant.Client.Core.BaseUrl" "servant-client-core-0.19-DAS79QGMO4DL64AFO0JBqz" ' 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"}

newtype InvalidBaseUrlException Source #

Constructors

InvalidBaseUrlException String

Instances

Instances details
Show InvalidBaseUrlException Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

showsPrec :: Int -> InvalidBaseUrlException -> ShowS Source #

show :: InvalidBaseUrlException -> String Source #

showList :: [ InvalidBaseUrlException ] -> ShowS Source #

Exception InvalidBaseUrlException Source #
Instance details

Defined in Servant.Client.Core.BaseUrl

Methods

toException :: InvalidBaseUrlException -> SomeException Source #

fromException :: SomeException -> Maybe InvalidBaseUrlException Source #

displayException :: InvalidBaseUrlException -> String Source #

Streaming

class RunClient m => RunStreamingClient m where Source #

Methods

withStreamingRequest :: Request -> ( StreamingResponse -> IO a) -> m a Source #

type StreamingResponse = ResponseF ( SourceIO ByteString ) Source #

Writing HasClient instances

These functions need not be re-exported by backend libraries.

addHeader :: ToHttpApiData a => HeaderName -> a -> Request -> Request Source #

appendToQueryString Source #

Arguments

:: Text

param name

-> Maybe ByteString

param value

-> Request
-> Request

appendToPath :: Text -> Request -> Request Source #

setRequestBodyLBS :: ByteString -> MediaType -> Request -> Request Source #

Set body and media type of the request being constructed.

The body is set to the given bytestring using the RequestBodyLBS constructor.

Since: 0.12

setRequestBody :: RequestBody -> MediaType -> Request -> Request Source #

Set body and media type of the request being constructed.

Since: 0.12