Servant.Client.Core.BaseUrl · servant-client-core-0.20.2

datadata BaseUrl

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

Constructors

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

Instances12Eq, Data, Ord, Show, Generic, NFData, …

Eq BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Data BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Ord BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Show BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Generic BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
NFData BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

FromJSON BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

Example1 expression

>>> parseBaseUrl "api.example.com" >>= decode . encode :: Maybe BaseUrlJust (BaseUrl {baseUrlScheme = Http, baseUrlHost = "api.example.com", baseUrlPort = 80, baseUrlPath = ""})

FromJSONKey BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

ToJSON BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

Example1 expression

>>> traverse_ (LBS8.putStrLn . encode) (parseBaseUrl "api.example.com" :: [BaseUrl])"http://api.example.com"

ToJSONKey BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

Example1 expression

>>> :{traverse_ (LBS8.putStrLn . encode) $ do  u1 <- parseBaseUrl "api.example.com" :: [BaseUrl]  u2 <- parseBaseUrl "example.com" :: [BaseUrl]  return $ Map.fromList [(u1, 'x'), (u2, 'y')]:}{"http://api.example.com":"x","http://example.com":"y"}

Lift BaseUrlDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
type Rep BaseUrl = D1 ('MetaData "BaseUrl" "Servant.Client.Core.BaseUrl" "servant-client-core-0.20.2-7n9f1ON2T6sQmlncz8W9t" 'False) (C1 ('MetaCons "BaseUrl" 'PrefixI 'True) ((S1 ('MetaSel ('Just "baseUrlScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scheme) :*: S1 ('MetaSel ('Just "baseUrlHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String)) :*: (S1 ('MetaSel ('Just "baseUrlPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedUnpack) (Rec0 Int) :*: S1 ('MetaSel ('Just "baseUrlPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String))))Defined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

datadata Scheme

URI scheme to use

Constructors

Http
http://
Https
https://

Instances7Eq, Data, Ord, Show, Generic, Lift, …

Eq SchemeDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Data SchemeDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Ord SchemeDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Show SchemeDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Generic SchemeDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Lift SchemeDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
type Rep Scheme = D1 ('MetaData "Scheme" "Servant.Client.Core.BaseUrl" "servant-client-core-0.20.2-7n9f1ON2T6sQmlncz8W9t" 'False) (C1 ('MetaCons "Http" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Https" 'PrefixI 'False) U1)Defined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl

valueshowBaseUrl :: BaseUrl -> String

Example1 expression

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

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

Example1 expression

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

Note: trailing slash is removed

Example1 expression

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

Example1 expression

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

newtypenewtype InvalidBaseUrlException

Constructors

InvalidBaseUrlException String

Instances2Show, Exception

Show InvalidBaseUrlExceptionDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl
Exception InvalidBaseUrlExceptionDefined in servant-client-core-0.20.2 · Servant.Client.Core.BaseUrl