-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | A family of combinators for defining webservices APIs
--   
--   A family of combinators for defining webservices APIs and serving them
--   . You can learn about the basics in the tutorial. .
--   CHANGELOG
@package servant
@version 0.20.3.0

module Servant.API.Alternative

-- | Union of two APIs, first takes precedence in case of overlap.
--   
--   Example:
--   
--   
--   >>> :{
--   type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
--          :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] () -- POST /books
--   :}
--   
data a :<|> b
(:<|>) :: a -> b -> (:<|>) a b
infixr 3 :<|>
infixr 3 :<|>
instance Data.Biapplicative.Biapplicative (Servant.API.Alternative.:<|>)
instance Data.Bifoldable.Bifoldable (Servant.API.Alternative.:<|>)
instance Data.Bifunctor.Bifunctor (Servant.API.Alternative.:<|>)
instance Data.Bitraversable.Bitraversable (Servant.API.Alternative.:<|>)
instance (GHC.Internal.Enum.Bounded a, GHC.Internal.Enum.Bounded b) => GHC.Internal.Enum.Bounded (a Servant.API.Alternative.:<|> b)
instance (GHC.Classes.Eq a, GHC.Classes.Eq b) => GHC.Classes.Eq (a Servant.API.Alternative.:<|> b)
instance GHC.Internal.Data.Foldable.Foldable ((Servant.API.Alternative.:<|>) a)
instance GHC.Internal.Base.Functor ((Servant.API.Alternative.:<|>) a)
instance (GHC.Internal.Base.Monoid a, GHC.Internal.Base.Monoid b) => GHC.Internal.Base.Monoid (a Servant.API.Alternative.:<|> b)
instance (GHC.Internal.Base.Semigroup a, GHC.Internal.Base.Semigroup b) => GHC.Internal.Base.Semigroup (a Servant.API.Alternative.:<|> b)
instance (GHC.Internal.Show.Show a, GHC.Internal.Show.Show b) => GHC.Internal.Show.Show (a Servant.API.Alternative.:<|> b)
instance GHC.Internal.Data.Traversable.Traversable ((Servant.API.Alternative.:<|>) a)

module Servant.API.BasicAuth

-- | Combinator for Basic Access Authentication.
--   
--   
--   
- IMPORTANT*: Only use Basic Auth over HTTPS! Credentials are not
--   hashed or encrypted. Note also that because the same credentials are
--   sent on every request, Basic Auth is not as secure as some
--   alternatives. Further, the implementation in servant-server does not
--   protect against some types of timing attacks.
--   
--   
--   In Basic Auth, username and password are base64-encoded and
--   transmitted via the Authorization header. Handshakes are not
--   required, making it relatively efficient.
data BasicAuth (realm :: Symbol) userData

-- | A simple datatype to hold data required to decorate a request
data BasicAuthData
BasicAuthData :: !ByteString -> !ByteString -> BasicAuthData
[basicAuthUsername] :: BasicAuthData -> !ByteString
[basicAuthPassword] :: BasicAuthData -> !ByteString

module Servant.API.Capture

-- | Capture a value from the request path under a certain type a.
--   
--   Example:
--   
--   
--   >>> -- GET /books/:isbn
--   
--   >>> type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
--   
type Capture = Capture' '[] :: [Type]

-- | Capture which can be modified. For example with
--   Description.
data Capture' (mods :: [Type]) (sym :: Symbol) a

-- | Capture all remaining values from the request path under a certain
--   type a.
--   
--   Example:
--   
--   
--   >>> -- GET /src/*
--   
--   >>> type MyAPI = "src" :> CaptureAll "segments" Text :> Get '[JSON] SourceFile
--   
data CaptureAll (sym :: Symbol) a

-- | A collection of basic Content-Types (also known as Internet Media
--   Types, or MIME types). Additionally, this module provides classes that
--   encapsulate how to serialize or deserialize values to or from a
--   particular Content-Type.
--   
--   Content-Types are used in ReqBody and the method combinators:
--   
--   
--   >>> type MyEndpoint = ReqBody '[JSON, PlainText] Book :> Put '[JSON, PlainText] Book
--   
--   
--   Meaning the endpoint accepts requests of Content-Type
--   application/json or text/plain;charset=utf8, and
--   returns data in either one of those formats (depending on the
--   Accept header).
--   
--   If you would like to support Content-Types beyond those provided here,
--   then:
--   
--   
--   
- Declare a new data type with no constructors (e.g. data
--   HTML).
--   
- Make an instance of it for Accept.
--   
- If you want to be able to serialize data *into* that Content-Type,
--   make an instance of it for MimeRender.
--   
- If you want to be able to deserialize data *from* that
--   Content-Type, make an instance of it for MimeUnrender.
--   
--   
--   Note that roles are reversed in servant-server and
--   servant-client: to be able to serve (or even typecheck) a
--   Get '[JSON, XML] MyData, you'll need to have the appropriate
--   MimeRender instances in scope, whereas to query that endpoint
--   with servant-client, you'll need a MimeUnrender
--   instance in scope.
module Servant.API.ContentTypes
data JSON
data PlainText
data FormUrlEncoded
data OctetStream
data EventStream

-- | Instances of Accept represent mimetypes. They are used for
--   matching against the Accept HTTP header of the request, and
--   for setting the Content-Type header of the response
--   
--   Example:
--   
--   
--   >>> import Network.HTTP.Media ((//), (/:))
--   
--   >>> data HTML
--   
--   >>> :{
--   instance Accept HTML where
--      contentType _ = "text" // "html" /: ("charset", "utf-8")
--   :}
--   
class Accept (ctype :: k)
contentType :: Accept ctype => Proxy ctype -> MediaType
contentTypes :: Accept ctype => Proxy ctype -> NonEmpty MediaType

-- | Instantiate this class to register a way of serializing a type based
--   on the Accept header.
--   
--   Example:
--   
--   
--   data MyContentType
--   
--   instance Accept MyContentType where
--      contentType _ = "example" // "prs.me.mine" /: ("charset", "utf-8")
--   
--   instance Show a => MimeRender MyContentType a where
--      mimeRender _ val = pack ("This is MINE! " ++ show val)
--   
--   type MyAPI = "path" :> Get '[MyContentType] Int
--   
class Accept ctype => MimeRender (ctype :: k) a
mimeRender :: MimeRender ctype a => Proxy ctype -> a -> ByteString

-- | Instantiate this class to register a way of deserializing a type based
--   on the request's Content-Type header.
--   
--   
--   >>> import Network.HTTP.Media hiding (Accept)
--   
--   >>> import qualified Data.ByteString.Lazy.Char8 as BSC
--   
--   >>> data MyContentType = MyContentType String
--   
--   
--   
--   >>> :{
--   instance Accept MyContentType where
--      contentType _ = "example" // "prs.me.mine" /: ("charset", "utf-8")
--   :}
--   
--   
--   
--   >>> :{
--   instance Read a => MimeUnrender MyContentType a where
--      mimeUnrender _ bs = case BSC.take 12 bs of
--        "MyContentType" -> return . read . BSC.unpack $ BSC.drop 12 bs
--        _ -> Left "didn't start with the magic incantation"
--   :}
--   
--   
--   
--   >>> type MyAPI = "path" :> ReqBody '[MyContentType] Int :> Get '[JSON] Int
--   
class Accept ctype => MimeUnrender (ctype :: k) a
mimeUnrender :: MimeUnrender ctype a => Proxy ctype -> ByteString -> Either String a

-- | Variant which is given the actual MediaType provided by the
--   other party.
--   
--   In the most cases you don't want to branch based on the
--   MediaType. See pr552 for a motivating example.
mimeUnrenderWithType :: MimeUnrender ctype a => Proxy ctype -> MediaType -> ByteString -> Either String a

-- | A type for responses without content-body.
data NoContent
NoContent :: NoContent
newtype AcceptHeader
AcceptHeader :: ByteString -> AcceptHeader
class AllMime list => AllCTRender (list :: [Type]) a
handleAcceptH :: AllCTRender list a => Proxy list -> AcceptHeader -> a -> Maybe (ByteString, ByteString)
class AllCTUnrender (list :: [Type]) a
canHandleCTypeH :: AllCTUnrender list a => Proxy list -> ByteString -> Maybe (ByteString -> Either String a)
handleCTypeH :: AllCTUnrender list a => Proxy list -> ByteString -> ByteString -> Maybe (Either String a)
class AllMime (list :: [Type])
allMime :: AllMime list => Proxy list -> [MediaType]
class AllMime list => AllMimeRender (list :: [Type]) a
allMimeRender :: AllMimeRender list a => Proxy list -> a -> [(MediaType, ByteString)]
class AllMime list => AllMimeUnrender (list :: [Type]) a
allMimeUnrender :: AllMimeUnrender list a => Proxy list -> [(MediaType, ByteString -> Either String a)]

-- | Deprecated: since aeson version 0.9 eitherDecode has lenient
--   behavior.

-- | Deprecated: use eitherDecode instead
eitherDecodeLenient :: FromJSON a => ByteString -> Either String a
canHandleAcceptH :: forall (list :: [Type]). AllMime list => Proxy list -> AcceptHeader -> Bool

-- | Chunk of an event stream
newtype EventStreamChunk
EventStreamChunk :: ByteString -> EventStreamChunk
[unEventStreamChunk] :: EventStreamChunk -> ByteString
instance Servant.API.ContentTypes.Accept Servant.API.ContentTypes.EventStream
instance Servant.API.ContentTypes.Accept Servant.API.ContentTypes.FormUrlEncoded
instance Servant.API.ContentTypes.Accept Servant.API.ContentTypes.JSON
instance Servant.API.ContentTypes.Accept Servant.API.ContentTypes.OctetStream
instance Servant.API.ContentTypes.Accept Servant.API.ContentTypes.PlainText
instance (Servant.API.ContentTypes.Accept ct, Servant.API.ContentTypes.AllMime cts, Servant.API.ContentTypes.AllMimeRender (ct : cts) a) => Servant.API.ContentTypes.AllCTRender (ct : cts) a
instance (TypeError ...) => Servant.API.ContentTypes.AllCTRender '[] ()
instance Servant.API.ContentTypes.AllMimeUnrender ctyps a => Servant.API.ContentTypes.AllCTUnrender ctyps a
instance Servant.API.ContentTypes.Accept ctyp => Servant.API.ContentTypes.AllMimeRender '[ctyp] Servant.API.ContentTypes.NoContent
instance Servant.API.ContentTypes.AllMime (ctyp : ctyp' : ctyps) => Servant.API.ContentTypes.AllMimeRender (ctyp : ctyp' : ctyps) Servant.API.ContentTypes.NoContent
instance Servant.API.ContentTypes.MimeRender ctyp a => Servant.API.ContentTypes.AllMimeRender '[ctyp] a
instance (Servant.API.ContentTypes.MimeRender ctyp a, Servant.API.ContentTypes.AllMimeRender (ctyp' : ctyps) a) => Servant.API.ContentTypes.AllMimeRender (ctyp : ctyp' : ctyps) a
instance (Servant.API.ContentTypes.MimeUnrender ctyp a, Servant.API.ContentTypes.AllMimeUnrender ctyps a) => Servant.API.ContentTypes.AllMimeUnrender (ctyp : ctyps) a
instance Servant.API.ContentTypes.AllMimeUnrender '[] a
instance (Servant.API.ContentTypes.Accept ctyp, Servant.API.ContentTypes.AllMime ctyps) => Servant.API.ContentTypes.AllMime (ctyp : ctyps)
instance Servant.API.ContentTypes.AllMime '[]
instance GHC.Classes.Eq Servant.API.ContentTypes.AcceptHeader
instance GHC.Classes.Eq Servant.API.ContentTypes.NoContent
instance GHC.Internal.Generics.Generic Servant.API.ContentTypes.AcceptHeader
instance GHC.Internal.Generics.Generic Servant.API.ContentTypes.NoContent
instance Web.Internal.FormUrlEncoded.ToForm a => Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.FormUrlEncoded a
instance Data.Aeson.Types.ToJSON.ToJSON a => Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.JSON a
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.OctetStream Data.ByteString.Internal.Type.ByteString
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.OctetStream Data.ByteString.Lazy.Internal.ByteString
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.PlainText GHC.Internal.Base.String
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.PlainText Data.Text.Internal.Text
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.PlainText Data.Text.Internal.Lazy.Text
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.EventStream Servant.API.ContentTypes.EventStreamChunk
instance Web.Internal.FormUrlEncoded.FromForm a => Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.FormUrlEncoded a
instance Data.Aeson.Types.FromJSON.FromJSON a => Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.JSON a
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.OctetStream Data.ByteString.Internal.Type.ByteString
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.OctetStream Data.ByteString.Lazy.Internal.ByteString
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.PlainText GHC.Internal.Base.String
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.PlainText Data.Text.Internal.Text
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.PlainText Data.Text.Internal.Lazy.Text
instance Control.DeepSeq.NFData Servant.API.ContentTypes.NoContent
instance GHC.Internal.Read.Read Servant.API.ContentTypes.AcceptHeader
instance GHC.Internal.Read.Read Servant.API.ContentTypes.NoContent
instance GHC.Internal.Show.Show Servant.API.ContentTypes.AcceptHeader
instance GHC.Internal.Show.Show Servant.API.ContentTypes.NoContent

module Servant.API.Description

-- | Add more verbose description for (part of) API.
--   
--   Example:
--   
--   
--   >>> :{
--   type MyApi = Description
--    "This comment is visible in multiple Servant interpretations \
--    \and can be really long if necessary. \
--    \Haskell multiline String support is not perfect \
--    \but it's still very readable."
--   :> Get '[JSON] Book
--   :}
--   
data Description (sym :: Symbol)

-- | Add a short summary for (part of) API.
--   
--   Example:
--   
--   
--   >>> type MyApi = Summary "Get book by ISBN." :> "books" :> Capture "isbn" Text :> Get '[JSON] Book
--   
data Summary (sym :: Symbol)

-- | Fold list of modifiers to extract description as a type-level String.
--   
--   
--   >>> :kind! FoldDescription '[]
--   FoldDescription '[] :: Symbol
--   = ""
--   
--   
--   
--   >>> :kind! FoldDescription '[Required, Description "foobar", Lenient]
--   FoldDescription '[Required, Description "foobar", Lenient] :: Symbol
--   = "foobar"
--   
type FoldDescription (mods :: [Type]) = FoldDescription' "" mods

-- | Implementation of FoldDescription.
type family FoldDescription' (acc :: Symbol) (mods :: [Type]) :: Symbol

-- | Reflect description to the term level.
--   
--   
--   >>> reflectDescription (Proxy :: Proxy '[Required, Description "foobar", Lenient])
--   "foobar"
--   
reflectDescription :: forall (mods :: [Type]). KnownSymbol (FoldDescription mods) => Proxy mods -> String

module Servant.API.Empty

-- | An empty API: one which serves nothing. Morally speaking, this should
--   be the unit of :<|>. Implementors of interpretations of
--   API types should treat EmptyAPI as close to the unit as
--   possible.
data EmptyAPI
EmptyAPI :: EmptyAPI
instance GHC.Internal.Enum.Bounded Servant.API.Empty.EmptyAPI
instance GHC.Internal.Enum.Enum Servant.API.Empty.EmptyAPI
instance GHC.Classes.Eq Servant.API.Empty.EmptyAPI
instance GHC.Internal.Show.Show Servant.API.Empty.EmptyAPI

module Servant.API.Experimental.Auth

-- | A generalized Authentication combinator. Use this if you have a
--   non-standard authentication technique.
--   
--   NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE.
data AuthProtect (tag :: k)

module Servant.API.Fragment

-- | Document the URI fragment in API. Useful in combination with
--   Link.
--   
--   Example:
--   
--   
--   >>> -- /post#TRACKING
--   
--   >>> type MyApi = "post" :> Fragment Text :> Get '[JSON] Tracking
--   
data Fragment a

-- | Define servant servers from record types. Generics for the win.
--   
--   The usage is simple, if you only need a collection of routes. First
--   you define a record with field types prefixed by a parameter
--   route:
--   
--   
--   data Routes route = Routes
--       { _get :: route :- Capture "id" Int :> Get '[JSON] String
--       , _put :: route :- ReqBody '[JSON] Int :> Put '[JSON] Bool
--       }
--     deriving (Generic)
--   
--   
--   You can get a Proxy of the server using
--   
--   
--   api :: Proxy (ToServantApi Routes)
--   api = genericApi (Proxy :: Proxy Routes)
--   
--   
--   Using genericApi is better as it checks that instances exists,
--   i.e. you get better error messages than simply using Proxy
--   value.
--   
--   Note: in 0.14 series this module isn't re-exported from
--   API.
--   
--   Servant.API.Generic is based on servant-generic
--   package by Patrick Chilton
module Servant.API.Generic

-- | A class with a type family that applies an appropriate type family to
--   the api parameter. For example, AsApi will leave
--   api untouched, while AsServerT m will
--   produce ServerT api m.
class GenericMode (mode :: k) where {
    type (mode :: k) :- api;
}
infixl 0 :-

-- | A constraint alias, for work with mode and routes.
type GenericServant (routes :: k -> Type) (mode :: k) = (GenericMode mode, Generic routes mode, GServantProduct Rep routes mode)

-- | Turns a generic product type into a tree of :<|>
--   combinators.
type ToServant (routes :: k -> Type) (mode :: k) = GToServant Rep routes mode

-- | See ToServant, but at value-level.
toServant :: forall {k} routes (mode :: k). GenericServant routes mode => routes mode -> ToServant routes mode

-- | Inverse of toServant.
--   
--   This can be used to turn generated values such as client
--   functions into records.
--   
--   You may need to provide a type signature for the output type
--   (your record type).
fromServant :: forall {k} routes (mode :: k). GenericServant routes mode => ToServant routes mode -> routes mode

-- | A type that specifies that an API record contains an API definition.
--   Only useful at type-level.
data AsApi
type ToServantApi (routes :: Type -> Type) = ToServant routes AsApi

-- | Get a Proxy of an API type.
genericApi :: forall (routes :: Type -> Type). GenericServant routes AsApi => Proxy routes -> Proxy (ToServantApi routes)
class GServantProduct (f :: k -> Type)

-- | Representable types of kind *. This class is derivable in GHC
--   with the DeriveGeneric flag on.
--   
--   A Generic instance must satisfy the following laws:
--   
--   
--   from . to ≡ id
--   to . from ≡ id
--   
class Generic a where {
    
    -- | Generic representation type
    type Rep a :: Type -> Type;
}
instance forall k (l :: k -> GHC.Types.Type) (r :: k -> GHC.Types.Type). (Servant.API.Generic.GServantProduct l, Servant.API.Generic.GServantProduct r) => Servant.API.Generic.GServantProduct (l GHC.Internal.Generics.:*: r)
instance Servant.API.Generic.GServantProduct (GHC.Internal.Generics.K1 i c)
instance forall k (f :: k -> GHC.Types.Type) i (c :: GHC.Internal.Generics.Meta). Servant.API.Generic.GServantProduct f => Servant.API.Generic.GServantProduct (GHC.Internal.Generics.M1 i c f)
instance Servant.API.Generic.GenericMode Servant.API.Generic.AsApi

module Servant.API.Host

-- | Match against the given host.
--   
--   This allows you to define APIs over multiple domains. For example:
--   
--   
--   type API = Host "api1.example" :> API1
--         :<|> Host "api2.example" :> API2
--   
data Host (sym :: Symbol)

module Servant.API.HttpVersion

-- | HTTP Version.
--   
--   Note that the Show instance is intended merely for debugging.
data HttpVersion
HttpVersion :: !Int -> !Int -> HttpVersion
[httpMajor] :: HttpVersion -> !Int
[httpMinor] :: HttpVersion -> !Int

module Servant.API.IsSecure

-- | Was this request made over an SSL connection?
--   
--   Note that this value will not tell you if the client originally made
--   this request over SSL, but rather whether the current connection is
--   SSL. The distinction lies with reverse proxies. In many cases, the
--   client will connect to a load balancer over SSL, but connect to the
--   WAI handler without SSL. In such a case, the handlers would get
--   NotSecure, but from a user perspective, there is a secure
--   connection.
data IsSecure

-- | the connection to the server is secure (HTTPS)
Secure :: IsSecure

-- | the connection to the server is not secure (HTTP)
NotSecure :: IsSecure
instance GHC.Classes.Eq Servant.API.IsSecure.IsSecure
instance GHC.Internal.Generics.Generic Servant.API.IsSecure.IsSecure
instance GHC.Classes.Ord Servant.API.IsSecure.IsSecure
instance GHC.Internal.Read.Read Servant.API.IsSecure.IsSecure
instance GHC.Internal.Show.Show Servant.API.IsSecure.IsSecure

module Servant.API.Modifiers

-- | Required argument. Not wrapped.
data Required

-- | Optional argument. Wrapped in Maybe.
data Optional

-- | Fold modifier list to decide whether argument is required.
--   
--   
--   >>> :kind! FoldRequired '[Required, Description "something"]
--   FoldRequired '[Required, Description "something"] :: Bool
--   = 'True
--   
--   
--   
--   >>> :kind! FoldRequired '[Required, Optional]
--   FoldRequired '[Required, Optional] :: Bool
--   = 'False
--   
--   
--   
--   >>> :kind! FoldRequired '[]
--   FoldRequired '[] :: Bool
--   = 'False
--   
type FoldRequired (mods :: [Type]) = FoldRequired' 'False mods

-- | Implementation of FoldRequired.
type family FoldRequired' (acc :: Bool) (mods :: [Type]) :: Bool

-- | Leniently parsed argument, i.e. parsing never fail. Wrapped in
--   Either Text.
data Lenient

-- | Strictly parsed argument. Not wrapped.
data Strict

-- | Fold modifier list to decide whether argument should be parsed
--   strictly or leniently.
--   
--   
--   >>> :kind! FoldLenient '[]
--   FoldLenient '[] :: Bool
--   = 'False
--   
type FoldLenient (mods :: [Type]) = FoldLenient' 'False mods

-- | Implementation of FoldLenient.
type family FoldLenient' (acc :: Bool) (mods :: [Type]) :: Bool

-- | Helper type alias.
--   
--   
--   
- Required ↦ a
--   
- Optional ↦ Maybe a
--   
type RequiredArgument (mods :: [Type]) a = If FoldRequired mods a Maybe a

-- | Fold a RequiredAgument into a value
foldRequiredArgument :: forall (mods :: [Type]) a r. SBoolI (FoldRequired mods) => Proxy mods -> (a -> r) -> (Maybe a -> r) -> RequiredArgument mods a -> r

-- | Unfold a value into a RequiredArgument.
unfoldRequiredArgument :: forall (mods :: [Type]) m a. (Monad m, SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)) => Proxy mods -> m (RequiredArgument mods a) -> (Text -> m (RequiredArgument mods a)) -> Maybe (Either Text a) -> m (RequiredArgument mods a)

-- | Helper type alias.
--   
--   By default argument is Optional and Strict.
--   
--   
--   
- Required, Strict ↦ a
--   
- Required, Lenient ↦ Either Text
--   a
--   
- Optional, Strict ↦ Maybe a
--   
- Optional, Lenient ↦ Maybe (Either
--   Text a)
--   
type RequestArgument (mods :: [Type]) a = If FoldRequired mods If FoldLenient mods Either Text a a Maybe If FoldLenient mods Either Text a a

-- | Unfold a value into a RequestArgument.
unfoldRequestArgument :: forall (mods :: [Type]) m a. (Monad m, SBoolI (FoldRequired mods), SBoolI (FoldLenient mods)) => Proxy mods -> m (RequestArgument mods a) -> (Text -> m (RequestArgument mods a)) -> Maybe (Either Text a) -> m (RequestArgument mods a)

module Servant.API.Header

-- | Extract the given header's value as a value of type a. I.e.
--   header sent by client, parsed by server.
--   
--   Example:
--   
--   
--   >>> newtype Referer = Referer Text deriving (Eq, Show)
--   
--   >>> 
--   
--   >>>            -- GET /view-my-referer
--   
--   >>> type MyApi = "view-my-referer" :> Header "from" Referer :> Get '[JSON] Referer
--   
type Header = Header' '[Optional, Strict]
data Header' (mods :: [Type]) (sym :: Symbol) a

module Servant.API.NamedRoutes

-- | Combinator for embedding a record of named routes into a Servant API
--   type.
data NamedRoutes (api :: Type -> Type)

module Servant.API.QueryParam

-- | Lookup a potentially value-less query string parameter with boolean
--   semantics. If the param sym is there without any value, or if
--   it's there with value "true" or "1", it's interpreted as True.
--   Otherwise, it's interpreted as False.
--   
--   Example:
--   
--   
--   >>> -- /books?published
--   
--   >>> type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]
--   
data QueryFlag (sym :: Symbol)

-- | Lookup the value associated to the sym query string parameter
--   and try to extract it as a value of type a.
--   
--   Example:
--   
--   
--   >>> -- /books?author=<author name>
--   
--   >>> type MyApi = "books" :> QueryParam "author" Text :> Get '[JSON] [Book]
--   
type QueryParam = QueryParam' '[Optional, Strict]

-- | QueryParam which can be Required, Lenient, or
--   modified otherwise.
data QueryParam' (mods :: [Type]) (sym :: Symbol) a

-- | Lookup the values associated to the sym query string
--   parameter and try to extract it as a value of type [a]. This
--   is typically meant to support query string parameters of the form
--   param[]=val1&param[]=val2 and so on. Note that servant
--   doesn't actually require the []s and will fetch the values
--   just fine with param=val1&param=val2, too.
--   
--   Example:
--   
--   
--   >>> -- /books?authors[]=<author1>&authors[]=<author2>&...
--   
--   >>> type MyApi = "books" :> QueryParams "authors" Text :> Get '[JSON] [Book]
--   
data QueryParams (sym :: Symbol) a

module Servant.API.QueryString

-- | Extract the whole query string from a request. This is useful for
--   query strings containing dynamic parameter names. For query strings
--   with static parameter names, QueryParam is more suited.
--   
--   Example:
--   
--   
--   >>> -- /books?author=<author name>&year=<book year>
--   
--   >>> type MyApi = "books" :> QueryString :> Get '[JSON] [Book]
--   
data QueryString

-- | Extract an deep object from a query string.
--   
--   Example:
--   
--   
--   >>> -- /books?filter[author][name]=<author name>&filter[year]=<book year>
--   
--   >>> type MyApi = "books" :> DeepQuery "filter" BookQuery :> Get '[JSON] [Book]
--   
data DeepQuery (sym :: Symbol) a

-- | Extract a deep object from (possibly nested) query parameters. a param
--   like filter[a][b][c]=d will be represented as '(["a",
--   "b", "c"], Just "d")'. Note that a parameter with no nested field
--   is possible: filter=a will be represented as '([], Just
--   "a")'
class FromDeepQuery a
fromDeepQuery :: FromDeepQuery a => [([Text], Maybe Text)] -> Either String a

-- | Generate query parameters from an object, using the deep object
--   syntax. A result of '(["a", "b", "c"], Just "d")' attributed
--   to the filter parameter name will result in the following
--   query parameter: filter[a][b][c]=d
class ToDeepQuery a
toDeepQuery :: ToDeepQuery a => a -> [([Text], Maybe Text)]

-- | Turn a nested path into a deep object query param
--   
--   
--   >>> generateDeepParam "filter" (["a", "b", "c"], Just "d")
--   ("filter[a][b][c]",Just "d")
--   
generateDeepParam :: Text -> ([Text], Maybe Text) -> (Text, Maybe Text)
instance Web.Internal.HttpApiData.FromHttpApiData a => Servant.API.QueryString.FromDeepQuery (Data.Map.Internal.Map Data.Text.Internal.Text a)

module Servant.API.Raw

-- | Endpoint for plugging in your own Wai Applications.
--   
--   The given Application will get the request as received by the
--   server, potentially with a modified (stripped) pathInfo if
--   the Application is being routed with :>.
--   
--   In addition to just letting you plug in your existing WAI
--   Applications, this can also be used with functions from
--   Servant.Server.StaticFiles to serve static files stored in a
--   particular directory on your filesystem
data Raw

-- | Variant of Raw that lets you access the underlying monadic
--   context to process the request.
data RawM

module Servant.API.RemoteHost

-- | Provides access to the host or IP address from which the HTTP request
--   was sent.
data RemoteHost

module Servant.API.ReqBody

-- | Extract the request body as a value of type a.
--   
--   Example:
--   
--   
--   >>> -- POST /books
--   
--   >>> type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book
--   
type ReqBody = ReqBody' '[Required, Strict]

-- | Note: ReqBody' is always Required.
data ReqBody' (mods :: [Type]) (contentTypes :: [Type]) a

-- | Server-sent events
--   
--   See https://www.w3.org/TR/2009/WD-eventsource-20090421/.
module Servant.API.ServerSentEvents

-- | Server-sent events (SSE)
--   
--   See https://www.w3.org/TR/2009/WD-eventsource-20090421/.
data ServerSentEvents' (method :: k) (status :: Nat) (kind :: EventKind) a
type ServerSentEvents = ServerSentEvents' 'GET 200

-- | Determines the shape of events you may receive (i.e. the a in
--   'ServerSentEvents'')
data EventKind

-- | EventMessage or Event ByteString
RawEvent :: EventKind

-- | Anything that implements FromJSON
JsonEvent :: EventKind
instance forall k (method :: k) (status :: GHC.Internal.TypeNats.Nat) (kind :: Servant.API.ServerSentEvents.EventKind) a. GHC.Internal.Generics.Generic (Servant.API.ServerSentEvents.ServerSentEvents' method status kind a)

module Servant.API.Status

-- | Retrieve a known or unknown Status from a KnownNat
statusFromNat :: forall (a :: Nat) proxy. KnownNat a => proxy a -> Status

-- | Witness that a type-level natural number corresponds to a HTTP status
--   code
class KnownNat n => KnownStatus (n :: Nat)
statusVal :: KnownStatus n => proxy n -> Status
instance Servant.API.Status.KnownStatus 511
instance Servant.API.Status.KnownStatus 505
instance Servant.API.Status.KnownStatus 504
instance Servant.API.Status.KnownStatus 503
instance Servant.API.Status.KnownStatus 502
instance Servant.API.Status.KnownStatus 501
instance Servant.API.Status.KnownStatus 500
instance Servant.API.Status.KnownStatus 431
instance Servant.API.Status.KnownStatus 429
instance Servant.API.Status.KnownStatus 428
instance Servant.API.Status.KnownStatus 426
instance Servant.API.Status.KnownStatus 422
instance Servant.API.Status.KnownStatus 418
instance Servant.API.Status.KnownStatus 417
instance Servant.API.Status.KnownStatus 416
instance Servant.API.Status.KnownStatus 415
instance Servant.API.Status.KnownStatus 414
instance Servant.API.Status.KnownStatus 413
instance Servant.API.Status.KnownStatus 412
instance Servant.API.Status.KnownStatus 411
instance Servant.API.Status.KnownStatus 410
instance Servant.API.Status.KnownStatus 409
instance Servant.API.Status.KnownStatus 408
instance Servant.API.Status.KnownStatus 407
instance Servant.API.Status.KnownStatus 406
instance Servant.API.Status.KnownStatus 405
instance Servant.API.Status.KnownStatus 404
instance Servant.API.Status.KnownStatus 403
instance Servant.API.Status.KnownStatus 402
instance Servant.API.Status.KnownStatus 401
instance Servant.API.Status.KnownStatus 400
instance Servant.API.Status.KnownStatus 308
instance Servant.API.Status.KnownStatus 307
instance Servant.API.Status.KnownStatus 305
instance Servant.API.Status.KnownStatus 304
instance Servant.API.Status.KnownStatus 303
instance Servant.API.Status.KnownStatus 302
instance Servant.API.Status.KnownStatus 301
instance Servant.API.Status.KnownStatus 300
instance Servant.API.Status.KnownStatus 206
instance Servant.API.Status.KnownStatus 205
instance Servant.API.Status.KnownStatus 204
instance Servant.API.Status.KnownStatus 203
instance Servant.API.Status.KnownStatus 202
instance Servant.API.Status.KnownStatus 201
instance Servant.API.Status.KnownStatus 200
instance Servant.API.Status.KnownStatus 101
instance Servant.API.Status.KnownStatus 100

module Servant.API.Sub

-- | The contained API (second argument) can be found under ("/" ++
--   path) (path being the first argument).
--   
--   Example:
--   
--   
--   >>> -- GET /hello/world
--   
--   >>> -- returning a JSON encoded World value
--   
--   >>> type MyApi = "hello" :> "world" :> Get '[JSON] World
--   
data (path :: k) :> a
infixr 4 :>

-- | This module defines the error messages used in type-level errors.
--   Type-level errors can signal non-existing instances, for instance when
--   a combinator is not applied to the correct number of arguments.
module Servant.API.TypeErrors

-- | No instance exists for tycls (expr :> ...) because
--   expr is not fully saturated.
type PartialApplication (tycls :: k) (expr :: k') = NoInstanceForSub tycls expr ':$$: 'ShowType expr ':<>: 'Text " expects " ':<>: 'ShowType Arity expr ':<>: 'Text " more arguments"

-- | No instance exists for expr.
type NoInstanceFor (expr :: k) = 'Text "There is no instance for " ':<>: 'ShowType expr

-- | No instance exists for tycls (expr :> ...) because
--   expr is not recognised.
type NoInstanceForSub (tycls :: k) (expr :: k') = 'Text "There is no instance for " ':<>: 'ShowType tycls ':<>: 'Text " (" ':<>: 'ShowType expr ':<>: 'Text " :> ...)"
type ErrorIfNoGeneric (routes :: Type -> Type) = Break NoGeneric routes :: Type Rep routes ()

module Servant.API.TypeLevel.List

-- | Append two type-level lists.
--   
--   Import it as
--   
--   
--   import Servant.API.TypeLevel.List (type (.++))
--   
type family (l1 :: [Type]) .++ (l2 :: [Type]) :: [Type]

-- | Type-level code for implementing and using UVerb. Heavily
--   inspired by world-peace.
module Servant.API.UVerb.Union
type IsMember (a :: u) (as :: [u]) = (Unique as, CheckElemIsMember a as, UElem a as)

-- | Check whether all values in a type-level list are distinct. This will
--   throw a nice error if there are any duplicate elements in the list.
type family Unique (xs :: [k])
type Union = NS I
inject :: UElem x xs => f x -> NS f xs
eject :: UElem x xs => NS f xs -> Maybe (f x)

-- | 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.
foldMapUnion :: forall c a (as :: [Type]). All c as => Proxy c -> (forall x. c x => x -> a) -> Union as -> a

-- | 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.
matchUnion :: forall a (as :: [Type]). IsMember a as => Union as -> Maybe a
instance forall a (x :: a) (xs :: [a]). Servant.API.UVerb.Union.UElem x (x : xs)
instance forall a (x :: a) (xs :: [a]) (x' :: a). Servant.API.UVerb.Union.UElem x xs => Servant.API.UVerb.Union.UElem x (x' : xs)

-- | This module provides facilities for adding headers to a response.
--   
--   
--   >>> let headerVal = addHeader "some-url" 5 :: Headers '[Header "Location" String] Int
--   
--   
--   The value is added to the header specified by the type
--   (Location in the example above).
module Servant.API.ResponseHeaders

-- | Response Header objects. You should never need to construct one
--   directly. Instead, use addOptionalHeader.
data Headers (ls :: [Type]) a
Headers :: a -> HList ls -> Headers (ls :: [Type]) a

-- | The underlying value of a Headers
[getResponse] :: Headers (ls :: [Type]) a -> a

-- | HList of headers.
[getHeadersHList] :: Headers (ls :: [Type]) a -> HList ls
data ResponseHeader (sym :: Symbol) a
Header :: a -> ResponseHeader (sym :: Symbol) a
MissingHeader :: ResponseHeader (sym :: Symbol) a
UndecodableHeader :: ByteString -> ResponseHeader (sym :: Symbol) a
class AddHeader (mods :: [Type]) (h :: Symbol) v orig new | mods h v orig -> new, new -> mods, new -> h, new -> v, new -> orig

-- | addHeader adds a header to a response. Note that it changes
--   the type of the value in the following ways:
--   
--   
--   
- A simple value is wrapped in "Headers '[hdr]":
--   
--   
--   
--   >>> let example0 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String;
--   
--   >>> getHeaders example0
--   [("someheader","5")]
--   
--   
--   
--   
- A value that already has a header has its new header *prepended*
--   to the existing list:
--   
--   
--   
--   >>> let example1 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String;
--   
--   >>> let example2 = addHeader True example1 :: Headers '[Header "1st" Bool, Header "someheader" Int] String
--   
--   >>> getHeaders example2
--   [("1st","true"),("someheader","5")]
--   
--   
--   Note that while in your handlers type annotations are not required,
--   since the type can be inferred from the API type, in other cases you
--   may find yourself needing to add annotations.
addHeader :: forall (h :: Symbol) v orig new. AddHeader '[Optional, Strict] h v orig new => v -> orig -> new

-- | Same as addHeader but works with Header', so it's
--   possible to use any mods.
addHeader' :: forall (mods :: [Type]) (h :: Symbol) v orig new. AddHeader mods h v orig new => v -> orig -> new

-- | Deliberately do not add a header to a value.
--   
--   
--   >>> let example1 = noHeader "hi" :: Headers '[Header "someheader" Int] String
--   
--   >>> getHeaders example1
--   []
--   
noHeader :: forall (h :: Symbol) v orig new. AddHeader '[Optional, Strict] h v orig new => orig -> new

-- | Same as noHeader but works with Header', so it's
--   possible to use any mods.
noHeader' :: forall (mods :: [Type]) (h :: Symbol) v orig new. AddHeader mods h v orig new => orig -> new
class HasResponseHeader (h :: Symbol) a (headers :: [Type])

-- | Look up a specific ResponseHeader, without having to know what
--   position it is in the HList.
--   
--   
--   >>> let example1 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String
--   
--   >>> let example2 = addHeader True example1 :: Headers '[Header "1st" Bool, Header "someheader" Int] String
--   
--   >>> lookupResponseHeader example2 :: ResponseHeader "someheader" Int
--   Header 5
--   
--   
--   
--   >>> lookupResponseHeader example2 :: ResponseHeader "1st" Bool
--   Header True
--   
--   
--   Usage of this function relies on an explicit type annotation of the
--   header to be looked up. This can be done with type annotations on the
--   result, or with an explicit type application. In this example, the
--   type of header value is determined by the type-inference, we only
--   specify the name of the header:
--   
--   
--   >>> :set -XTypeApplications
--   
--   >>> case lookupResponseHeader @"1st" example2 of { Header b -> b ; _ -> False }
--   True
--   
lookupResponseHeader :: forall (h :: Symbol) a (headers :: [Type]) r. HasResponseHeader h a headers => Headers headers r -> ResponseHeader h a
class BuildHeadersTo (hs :: [Type])
buildHeadersTo :: BuildHeadersTo hs => [Header] -> HList hs
class GetHeaders ls
getHeaders :: GetHeaders ls => ls -> [Header]

-- | Auxiliary class for GetHeaders (Headers hs a)
--   instance
class GetHeaders' (hs :: [Type])
type family HeaderValMap (f :: Type -> Type) (xs :: [Type]) :: [Type]
data HList (a :: [Type])
[HNil] :: HList ('[] :: [Type])
[HCons] :: forall (h :: Symbol) x (xs :: [Type]) (mods :: [Type]). ResponseHeader h x -> HList xs -> HList (Header' mods h x ': xs)
instance (GHC.Internal.TypeLits.KnownSymbol h, Web.Internal.HttpApiData.ToHttpApiData v) => Servant.API.ResponseHeaders.AddHeader mods h v (Servant.API.ResponseHeaders.Headers (fst : rest) a) (Servant.API.ResponseHeaders.Headers (Servant.API.Header.Header' mods h v : fst : rest) a)
instance Servant.API.ResponseHeaders.AddHeader mods h v old new => Servant.API.ResponseHeaders.AddHeader mods h v (Servant.API.UVerb.Union.Union '[old]) (Servant.API.UVerb.Union.Union '[new])
instance (Servant.API.ResponseHeaders.AddHeader mods h v old new, Servant.API.ResponseHeaders.AddHeader mods h v (Servant.API.UVerb.Union.Union oldrest) (Servant.API.UVerb.Union.Union newrest), oldrest GHC.Types.~ (a : as), newrest GHC.Types.~ (b : bs)) => Servant.API.ResponseHeaders.AddHeader mods h v (Servant.API.UVerb.Union.Union (old : a : as)) (Servant.API.UVerb.Union.Union (new : b : bs))
instance (GHC.Internal.TypeLits.KnownSymbol h, Web.Internal.HttpApiData.ToHttpApiData v, new GHC.Types.~ Servant.API.ResponseHeaders.Headers '[Servant.API.Header.Header' mods h v] a) => Servant.API.ResponseHeaders.AddHeader mods h v a new
instance (Web.Internal.HttpApiData.FromHttpApiData v, Servant.API.ResponseHeaders.BuildHeadersTo xs, GHC.Internal.TypeLits.KnownSymbol h) => Servant.API.ResponseHeaders.BuildHeadersTo (Servant.API.Header.Header' mods h v : xs)
instance Servant.API.ResponseHeaders.BuildHeadersTo '[]
instance GHC.Classes.Eq a => GHC.Classes.Eq (Servant.API.ResponseHeaders.ResponseHeader sym a)
instance GHC.Internal.Base.Functor (Servant.API.ResponseHeaders.Headers ls)
instance GHC.Internal.Base.Functor (Servant.API.ResponseHeaders.ResponseHeader sym)
instance (GHC.Internal.TypeLits.KnownSymbol h, Servant.API.ResponseHeaders.GetHeadersFromHList rest, Web.Internal.HttpApiData.ToHttpApiData v) => Servant.API.ResponseHeaders.GetHeaders' (Servant.API.Header.Header' mods h v : rest)
instance Servant.API.ResponseHeaders.GetHeaders' '[]
instance (GHC.Internal.TypeLits.KnownSymbol h, Web.Internal.HttpApiData.ToHttpApiData x, Servant.API.ResponseHeaders.GetHeadersFromHList xs) => Servant.API.ResponseHeaders.GetHeadersFromHList (Servant.API.Header.Header' mods h x : xs)
instance Servant.API.ResponseHeaders.GetHeadersFromHList '[]
instance Servant.API.ResponseHeaders.GetHeadersFromHList hs => Servant.API.ResponseHeaders.GetHeaders (Servant.API.ResponseHeaders.HList hs)
instance Servant.API.ResponseHeaders.GetHeaders' hs => Servant.API.ResponseHeaders.GetHeaders (Servant.API.ResponseHeaders.Headers hs a)
instance Servant.API.ResponseHeaders.HasResponseHeader h a (Servant.API.Header.Header' mods h a : rest)
instance Servant.API.ResponseHeaders.HasResponseHeader h a rest => Servant.API.ResponseHeaders.HasResponseHeader h a (first : rest)
instance (y GHC.Types.~ Servant.API.Header.Header' mods h x, Control.DeepSeq.NFData x, Servant.API.ResponseHeaders.NFDataHList xs) => Servant.API.ResponseHeaders.NFDataHList (y : xs)
instance Servant.API.ResponseHeaders.NFDataHList '[]
instance Servant.API.ResponseHeaders.NFDataHList xs => Control.DeepSeq.NFData (Servant.API.ResponseHeaders.HList xs)
instance (Servant.API.ResponseHeaders.NFDataHList ls, Control.DeepSeq.NFData a) => Control.DeepSeq.NFData (Servant.API.ResponseHeaders.Headers ls a)
instance Control.DeepSeq.NFData a => Control.DeepSeq.NFData (Servant.API.ResponseHeaders.ResponseHeader sym a)
instance GHC.Internal.Show.Show a => GHC.Internal.Show.Show (Servant.API.ResponseHeaders.ResponseHeader sym a)

-- | An alternative to Verb for end-points that respond with a
--   resource value of any of an open union of types, and specific status
--   codes for each type in this union. (UVerb is short for
--   UnionVerb)
--   
--   This can be used for returning (rather than throwing) exceptions in a
--   server as in, say '[Report, WaiError]; or responding with
--   either a 303 forward with a location header, or 201 created with a
--   different body type, depending on the circumstances. (All of this can
--   be done with vanilla servant-server by throwing exceptions, but it
--   can't be represented in the API types without something like
--   UVerb.)
--   
--   See
--   https://docs.servant.dev/en/stable/cookbook/uverb/UVerb.html
--   for a working example.
module Servant.API.UVerb

-- | A variant of Verb that can have any of a number of response
--   values and status codes.
--   
--   FUTUREWORK: it would be nice to make Verb a special case of
--   UVerb, and only write instances for HasServer etc. for
--   the latter, getting them for the former for free. Something like:
--   
--   
--   type Verb method statusCode contentTypes a = UVerb method contentTypes [WithStatus statusCode a]
--   
--   
--   Backwards compatibility is tricky, though: this type alias would mean
--   people would have to use respond instead of pure or
--   return, so all old handlers would have to be rewritten.
data UVerb (method :: StdMethod) (contentTypes :: [Type]) (as :: [Type])
class KnownStatus StatusOf a => HasStatus a where {
    type StatusOf a :: Nat;
}
statusOf :: HasStatus a => proxy a -> Status
class HasStatuses (as :: [Type]) where {
    type Statuses (as :: [Type]) :: [Nat];
}
statuses :: HasStatuses as => Proxy as -> [Status]

-- | A simple newtype wrapper that pairs a type with its status code. It
--   implements all the content types that Servant ships with by default.
newtype WithStatus (k :: Nat) a
WithStatus :: a -> WithStatus (k :: Nat) a
instance GHC.Classes.Eq a => GHC.Classes.Eq (Servant.API.UVerb.WithStatus k a)
instance Servant.API.UVerb.HasStatus a => Servant.API.UVerb.HasStatus (Servant.API.ResponseHeaders.Headers ls a)
instance Servant.API.UVerb.HasStatus Servant.API.ContentTypes.NoContent
instance Servant.API.Status.KnownStatus n => Servant.API.UVerb.HasStatus (Servant.API.UVerb.WithStatus n a)
instance (Servant.API.UVerb.HasStatus a, Servant.API.UVerb.HasStatuses as) => Servant.API.UVerb.HasStatuses (a : as)
instance Servant.API.UVerb.HasStatuses '[]
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.FormUrlEncoded a => Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.FormUrlEncoded (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.JSON a => Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.JSON (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.OctetStream a => Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.OctetStream (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.PlainText a => Servant.API.ContentTypes.MimeRender Servant.API.ContentTypes.PlainText (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.FormUrlEncoded a => Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.FormUrlEncoded (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.JSON a => Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.JSON (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.OctetStream a => Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.OctetStream (Servant.API.UVerb.WithStatus _status a)
instance Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.PlainText a => Servant.API.ContentTypes.MimeUnrender Servant.API.ContentTypes.PlainText (Servant.API.UVerb.WithStatus _status a)
instance GHC.Internal.Show.Show a => GHC.Internal.Show.Show (Servant.API.UVerb.WithStatus k a)

module Servant.API.Vault

-- | A persistent store for values of arbitrary types.
--   
--   This variant is the simplest and creates keys in the IO monad.
--   See the module Data.Vault.ST if you want to use it with the
--   ST monad instead.
type Vault = Vault RealWorld

module Servant.API.Verbs

-- | GET with 200 status code.
type Get = Verb 'GET 200

-- | PUT with 200 status code.
type Put = Verb 'PUT 200

-- | DELETE with 200 status code.
type Delete = Verb 'DELETE 200

-- | DELETE with 202 status code.
type DeleteAccepted = Verb 'DELETE 202

-- | DELETE with 204 status code.
type DeleteNoContent = NoContentVerb 'DELETE

-- | DELETE with 203 status code.
type DeleteNonAuthoritative = Verb 'DELETE 203

-- | GET with 202 status code.
type GetAccepted = Verb 'GET 202

-- | GET with 204 status code.
type GetNoContent = NoContentVerb 'GET

-- | GET with 203 status code.
type GetNonAuthoritative = Verb 'GET 203

-- | GET with 206 status code.
type GetPartialContent = Verb 'GET 206

-- | GET with 205 status code.
type GetResetContent = Verb 'GET 205

-- | NoContentVerb is a specific type to represent
--   NoContent responses. It does not require either a list of
--   content types (because there's no content) or a status code (because
--   it should always be 204).
data NoContentVerb (method :: k1)

-- | PATCH with 200 status code.
type Patch = Verb 'PATCH 200

-- | PATCH with 202 status code.
type PatchAccepted = Verb 'PATCH 202

-- | PATCH with 204 status code.
type PatchNoContent = NoContentVerb 'PATCH

-- | PATCH with 203 status code.
type PatchNonAuthoritative = Verb 'PATCH 203

-- | POST with 200 status code.
type Post = Verb 'POST 200

-- | POST with 202 status code.
type PostAccepted = Verb 'POST 202

-- | POST with 201 status code.
type PostCreated = Verb 'POST 201

-- | POST with 204 status code.
type PostNoContent = NoContentVerb 'POST

-- | POST with 203 status code.
type PostNonAuthoritative = Verb 'POST 203

-- | POST with 205 status code.
type PostResetContent = Verb 'POST 205

-- | PUT with 202 status code.
type PutAccepted = Verb 'PUT 202

-- | PUT with 201 status code.
type PutCreated = Verb 'PUT 201

-- | PUT with 204 status code.
type PutNoContent = NoContentVerb 'PUT

-- | PUT with 203 status code.
type PutNonAuthoritative = Verb 'PUT 203
class ReflectMethod (a :: k)
reflectMethod :: ReflectMethod a => Proxy a -> Method

-- | Verb is a general type for representing HTTP verbs (a.k.a.
--   methods). For convenience, type synonyms for each verb with a 200
--   response code are provided, but you are free to define your own:
--   
--   
--   >>> type Post204 contentTypes a = Verb 'POST 204 contentTypes a
--   
data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [Type]) a

-- | HEAD with 204 status code.
type HeadNoContent = NoContentVerb 'HEAD

-- | DELETE with 205 status code.
type DeleteResetContent = Verb 'DELETE 205

-- | PATCH with 205 status code.
type PatchResetContent = Verb 'PATCH 205

-- | PUT with 205 status code.
type PutResetContent = Verb 'PUT 205

-- | HTTP standard method (as defined by RFC 2616, and PATCH which is
--   defined by RFC 5789).
data StdMethod
GET :: StdMethod
POST :: StdMethod
HEAD :: StdMethod
PUT :: StdMethod
DELETE :: StdMethod
TRACE :: StdMethod
CONNECT :: StdMethod
OPTIONS :: StdMethod

PATCH :: StdMethod
instance forall k1 (method :: k1). GHC.Internal.Generics.Generic (Servant.API.Verbs.NoContentVerb method)
instance forall k1 (method :: k1) (statusCode :: GHC.Internal.TypeNats.Nat) (contentTypes :: [GHC.Types.Type]) a. GHC.Internal.Generics.Generic (Servant.API.Verbs.Verb method statusCode contentTypes a)
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.CONNECT
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.DELETE
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.GET
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.HEAD
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.OPTIONS
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.PATCH
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.POST
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.PUT
instance Servant.API.Verbs.ReflectMethod 'Network.HTTP.Types.Method.TRACE

-- | This module collects utilities for manipulating servant API
--   types. The functionality in this module is for advanced usage.
--   
--   The code samples in this module use the following type synonym:
--   
--   
--   type SampleAPI = "hello" :> Get '[JSON] Int
--               :<|> "bye" :> Capture "name" String :> Post '[JSON, PlainText] Bool
--   
module Servant.API.TypeLevel

-- | Flatten API into a list of endpoints.
--   
--   
--   >>> Refl :: Endpoints SampleAPI :~: '["hello" :> Verb 'GET 200 '[JSON] Int, "bye" :> (Capture "name" String :> Verb 'POST 200 '[JSON, PlainText] Bool)]
--   Refl
--   
type family Endpoints api :: [Type]

-- | You may use this type family to tell the type checker that your custom
--   type may be skipped as part of a link. This is useful for things like
--   QueryParam that are optional in a URI and do not
--   affect them if they are omitted.
--   
--   
--   >>> data CustomThing
--   
--   >>> type instance IsElem' e (CustomThing :> s) = IsElem e s
--   
--   
--   Note that IsElem is called, which will mutually
--   recurse back to IsElem' if it exhausts all other
--   options again.
--   
--   Once you have written a HasLink instance for
--   CustomThing you are ready to go.
type family IsElem' a s

-- | Closed type family, check if endpoint is within api.
--   Uses IsElem' if it exhausts all other options.
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem ("hello" :> Get '[JSON] Int) SampleAPI))
--   OK
--   
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem ("bye" :> Get '[JSON] Int) SampleAPI))
--   ...
--   ... Could not ...
--   ...
--   
--   
--   An endpoint is considered within an api even if it is missing
--   combinators that don't affect the URL:
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem (Get '[JSON] Int) (Header "h" Bool :> Get '[JSON] Int)))
--   OK
--   
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem (Get '[JSON] Int) (ReqBody '[JSON] Bool :> Get '[JSON] Int)))
--   OK
--   
--   
--   
--   
- N.B.:* IsElem a b can be seen as capturing the notion of
--   whether the URL represented by a would match the URL
--   represented by b, *not* whether a request represented by
--   a matches the endpoints serving b (for the latter,
--   use IsIn).
--   
type family IsElem endpoint api

-- | Check whether sub is a sub-API of api.
--   
--   
--   >>> ok (Proxy :: Proxy (IsSubAPI SampleAPI (SampleAPI :<|> Get '[JSON] Int)))
--   OK
--   
--   
--   
--   >>> ok (Proxy :: Proxy (IsSubAPI (SampleAPI :<|> Get '[JSON] Int) SampleAPI))
--   ...
--   ... Could not ...
--   ...
--   
--   
--   This uses IsElem for checking; thus the note there applies
--   here.
type family IsSubAPI sub api

-- | Check that every element of xs is an endpoint of api
--   (using IsElem).
type family AllIsElem (xs :: [Type]) api

-- | Closed type family, check if endpoint is exactly within
--   api.
--   
--   
--   >>> ok (Proxy :: Proxy (IsIn ("hello" :> Get '[JSON] Int) SampleAPI))
--   OK
--   
--   
--   Unlike IsElem, this requires an *exact* match.
--   
--   
--   >>> ok (Proxy :: Proxy (IsIn (Get '[JSON] Int) (Header "h" Bool :> Get '[JSON] Int)))
--   ...
--   ... Could not ...
--   ...
--   
type family IsIn endpoint api

-- | Check whether sub is a sub API of api.
--   
--   Like IsSubAPI, but uses IsIn rather than IsElem.
type family IsStrictSubAPI sub api

-- | Check that every element of xs is an endpoint of api
--   (using IsIn).
--   
--   
--   >>> ok (Proxy :: Proxy (AllIsIn (Endpoints SampleAPI) SampleAPI))
--   OK
--   
type family AllIsIn (xs :: [Type]) api

-- | Apply (e :>) to every API in xs.
type family MapSub (e :: k) (xs :: [Type]) :: [Type]

-- | Append two type-level lists.
type family AppendList (xs :: [a]) (ys :: [a]) :: [a]
type family IsSubList (a :: [t]) (b :: [t])

-- | Check that a value is an element of a list:
--   
--   
--   >>> ok (Proxy :: Proxy (Elem Bool '[Int, Bool]))
--   OK
--   
--   
--   
--   >>> ok (Proxy :: Proxy (Elem String '[Int, Bool]))
--   ...
--   ... [Char]...'[Int, Bool...
--   ...
--   
type Elem (e :: t) (es :: [t]) = ElemGo e es es
type family ElemGo (e :: t) (es :: [t]) (orig :: t1)

-- | If either a or b produce an empty constraint,
--   produce an empty constraint.
type family Or a b

-- | If both a or b produce an empty constraint, produce
--   an empty constraint.
type family And a b
type family FragmentUnique api

-- | If there is more than one fragment in an API endpoint, a compile-time
--   error is raised.
--   
--   
--   >>> type FailAPI = Fragment Bool :> Fragment Int :> Get '[JSON] NoContent
--   
--   >>> instance AtMostOneFragment FailAPI
--   ...
--   ...Only one Fragment allowed per endpoint in api...
--   ...
--   
class FragmentUnique api => AtMostOneFragment api
instance Servant.API.TypeLevel.AtMostOneFragment (Servant.API.Fragment.Fragment a)
instance Servant.API.TypeLevel.AtMostOneFragment (Servant.API.UVerb.UVerb m cts as)
instance forall k1 (m :: k1) (s :: GHC.Internal.TypeNats.Nat) (ct :: [GHC.Types.Type]) typ. Servant.API.TypeLevel.AtMostOneFragment (Servant.API.Verbs.Verb m s ct typ)

module Servant.API.WithNamedContext

-- | WithNamedContext names a specific tagged context to use for the
--   combinators in the API. (See also in servant-server,
--   Servant.Server.Context.) For example:
--   
--   
--   type UseNamedContextAPI = WithNamedContext "myContext" '[String] (
--       ReqBody '[JSON] Int :> Get '[JSON] Int)
--   
--   
--   Both the ReqBody and Get combinators will use the
--   WithNamedContext with type tag "myContext" as their context.
--   
--   Contexts are only relevant for servant-server.
--   
--   For more information, see the tutorial.
data WithNamedContext (name :: Symbol) (subContext :: [Type]) (subApi :: k)

module Servant.API.WithResource
data WithResource (res :: k)

-- | This module offers other servant libraries a minimalistic HTTP
--   response type.
--   
--   It is purely an internal API and SHOULD NOT be used by end-users of
--   Servant.
module Servant.Types.Internal.Response
data InternalResponse a
InternalResponse :: Status -> Seq Header -> a -> InternalResponse a
[statusCode] :: InternalResponse a -> Status
[headers] :: InternalResponse a -> Seq Header
[responseBody] :: InternalResponse a -> a
instance GHC.Classes.Eq a => GHC.Classes.Eq (Servant.Types.Internal.Response.InternalResponse a)
instance GHC.Internal.Data.Foldable.Foldable Servant.Types.Internal.Response.InternalResponse
instance GHC.Internal.Base.Functor Servant.Types.Internal.Response.InternalResponse
instance GHC.Internal.Generics.Generic (Servant.Types.Internal.Response.InternalResponse a)
instance GHC.Internal.Show.Show a => GHC.Internal.Show.Show (Servant.Types.Internal.Response.InternalResponse a)
instance GHC.Internal.Data.Traversable.Traversable Servant.Types.Internal.Response.InternalResponse

module Servant.Types.SourceT

-- | This is CPSised ListT.
newtype SourceT (m :: Type -> Type) a
SourceT :: (forall b. () => (StepT m a -> m b) -> m b) -> SourceT (m :: Type -> Type) a
[unSourceT] :: SourceT (m :: Type -> Type) a -> forall b. () => (StepT m a -> m b) -> m b
mapStepT :: forall (m :: Type -> Type) a b. (StepT m a -> StepT m b) -> SourceT m a -> SourceT m b

-- | ListT with additional constructors.
data StepT (m :: Type -> Type) a
Stop :: StepT (m :: Type -> Type) a
Error :: String -> StepT (m :: Type -> Type) a
Skip :: StepT m a -> StepT (m :: Type -> Type) a
Yield :: a -> StepT m a -> StepT (m :: Type -> Type) a
Effect :: m (StepT m a) -> StepT (m :: Type -> Type) a

-- | Create SourceT from Step.
--   
--   Note: often enough you want to use SourceT directly.
fromStepT :: forall (m :: Type -> Type) a. StepT m a -> SourceT m a

-- | Create pure SourceT.
--   
--   
--   >>> source "foo" :: SourceT Identity Char
--   fromStepT (Effect (Identity (Yield 'f' (Yield 'o' (Yield 'o' Stop)))))
--   
source :: forall f a (m :: Type -> Type). Foldable f => f a -> SourceT m a

-- | Get the answers.
--   
--   
--   >>> runSourceT (source "foo" :: SourceT Identity Char)
--   ExceptT (Identity (Right "foo"))
--   
--   
--   
--   >>> runSourceT (source "foo" :: SourceT [] Char)
--   ExceptT [Right "foo"]
--   
runSourceT :: forall (m :: Type -> Type) a. Monad m => SourceT m a -> ExceptT String m [a]
runStepT :: forall (m :: Type -> Type) a. Monad m => StepT m a -> ExceptT String m [a]

-- | Filter values.
--   
--   
--   >>> toList $ mapMaybe (\x -> if odd x then Just x else Nothing) (source [0..10]) :: [Int]
--   [1,3,5,7,9]
--   
--   
--   
--   >>> mapMaybe (\x -> if odd x then Just x else Nothing) (source [0..2]) :: SourceT Identity Int
--   fromStepT (Effect (Identity (Skip (Yield 1 (Skip Stop)))))
--   
--   
--   Illustrates why we need Skip.
mapMaybe :: forall (m :: Type -> Type) a b. Functor m => (a -> Maybe b) -> SourceT m a -> SourceT m b
mapMaybeStep :: forall (m :: Type -> Type) a b. Functor m => (a -> Maybe b) -> StepT m a -> StepT m b

-- | Run action for each value in the SourceT.
--   
--   
--   >>> foreach fail print $ source ("abc" :: String)
--   'a'
--   'b'
--   'c'
--   
foreach :: Monad m => (String -> m ()) -> (a -> m ()) -> SourceT m a -> m ()

-- | See foreach.
foreachStep :: Monad m => (String -> m ()) -> (a -> m ()) -> StepT m a -> m ()

-- | Traverse the StepT and call the given function for each
--   Yield.
foreachYieldStep :: forall (m :: Type -> Type) a b. Functor m => (a -> StepT m b -> StepT m b) -> StepT m a -> StepT m b
fromAction :: Functor m => (a -> Bool) -> m a -> SourceT m a
fromActionStep :: Functor m => (a -> Bool) -> m a -> StepT m a

-- | Read file.
--   
--   
--   >>> foreach fail BS.putStr (readFile "servant.cabal")
--   cabal-version:      3.0
--   name:               servant
--   ...
--   
readFile :: FilePath -> SourceT IO ByteString

-- | Transform using attoparsec parser.
--   
--   Note: parser should not accept empty input!
--   
--   
--   >>> let parser = A.skipWhile A8.isSpace_w8 >> A.takeWhile1 A8.isDigit_w8
--   
--   
--   
--   >>> runExcept $ runSourceT $ transformWithAtto parser (source $ [fromString "1 2 3"])
--   Right ["1","2","3"]
--   
--   
--   
--   >>> runExcept $ runSourceT $ transformWithAtto parser (source $ map fromString ["1", "2", "3"])
--   Right ["123"]
--   
--   
--   
--   >>> runExcept $ runSourceT $ transformWithAtto parser (source $ map fromString ["1", "2 3", "4"])
--   Right ["12","34"]
--   
--   
--   
--   >>> runExcept $ runSourceT $ transformWithAtto parser (source [fromString "foobar"])
--   Left "Failed reading: takeWhile1"
--   
transformWithAtto :: forall (m :: Type -> Type) a. Monad m => Parser a -> SourceT m ByteString -> SourceT m a
transformStepWithAtto :: forall a (m :: Type -> Type). Monad m => Parser a -> StepT m ByteString -> StepT m a
instance (Test.QuickCheck.Arbitrary.Arbitrary a, GHC.Internal.Base.Monad m) => Test.QuickCheck.Arbitrary.Arbitrary (Servant.Types.SourceT.SourceT m a)
instance (Test.QuickCheck.Arbitrary.Arbitrary a, GHC.Internal.Base.Monad m) => Test.QuickCheck.Arbitrary.Arbitrary (Servant.Types.SourceT.StepT m a)
instance (GHC.Internal.Data.Functor.Identity.Identity GHC.Types.~ m) => GHC.Internal.Data.Foldable.Foldable (Servant.Types.SourceT.SourceT m)
instance (GHC.Internal.Data.Functor.Identity.Identity GHC.Types.~ m) => GHC.Internal.Data.Foldable.Foldable (Servant.Types.SourceT.StepT m)
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Functor (Servant.Types.SourceT.SourceT m)
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Functor (Servant.Types.SourceT.StepT m)
instance Control.Monad.Morph.MFunctor Servant.Types.SourceT.SourceT
instance Control.Monad.Morph.MFunctor Servant.Types.SourceT.StepT
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Monoid (Servant.Types.SourceT.SourceT m a)
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Monoid (Servant.Types.SourceT.StepT m a)
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Semigroup (Servant.Types.SourceT.SourceT m a)
instance GHC.Internal.Base.Functor m => GHC.Internal.Base.Semigroup (Servant.Types.SourceT.StepT m a)
instance (GHC.Internal.Base.Applicative m, Data.Functor.Classes.Show1 m) => Data.Functor.Classes.Show1 (Servant.Types.SourceT.SourceT m)
instance (GHC.Internal.Base.Applicative m, Data.Functor.Classes.Show1 m) => Data.Functor.Classes.Show1 (Servant.Types.SourceT.StepT m)
instance (GHC.Internal.Base.Applicative m, Data.Functor.Classes.Show1 m, GHC.Internal.Show.Show a) => GHC.Internal.Show.Show (Servant.Types.SourceT.SourceT m a)
instance (GHC.Internal.Base.Applicative m, Data.Functor.Classes.Show1 m, GHC.Internal.Show.Show a) => GHC.Internal.Show.Show (Servant.Types.SourceT.StepT m a)

module Servant.API.Stream

-- | A Stream endpoint for a given method emits a stream of encoded values
--   at a given Content-Type, delimited by a framing
--   strategy. Type synonyms are provided for standard methods.
data Stream (method :: k1) (status :: Nat) framing contentType a
type StreamGet = Stream 'GET 200
type StreamPost = Stream 'POST 200

-- | A stream request body.
type StreamBody = StreamBody' '[] :: [Type]
data StreamBody' (mods :: [Type]) framing contentType a

-- | Stream endpoints may be implemented as producing a SourceIO
--   chunk.
--   
--   Clients reading from streaming endpoints can be implemented as
--   consuming a SourceIO chunk.
type SourceIO = SourceT IO

-- | ToSourceIO is intended to be implemented for types such as
--   Conduit, Pipe, etc. By implementing this class, all such streaming
--   abstractions can be used directly as endpoints.
class ToSourceIO chunk a | a -> chunk
toSourceIO :: ToSourceIO chunk a => a -> SourceIO chunk

-- | FromSourceIO is intended to be implemented for types such as
--   Conduit, Pipe, etc. By implementing this class, all such streaming
--   abstractions can be used directly on the client side for talking to
--   streaming endpoints.
class FromSourceIO chunk a | a -> chunk
fromSourceIO :: FromSourceIO chunk a => SourceIO chunk -> IO a

-- | Auxiliary class for ToSourceIO x (SourceT m x)
--   instance.
class SourceToSourceIO (m :: Type -> Type)
sourceToSourceIO :: SourceToSourceIO m => SourceT m a -> SourceT IO a

-- | The FramingRender class provides the logic for emitting a
--   framing strategy. The strategy transforms a SourceT m
--   a into SourceT m ByteString, therefore it
--   can prepend, append and intercalate framing structure around
--   chunks.
--   
--   Note: as the Monad m is generic, this is pure
--   transformation.
class FramingRender (strategy :: k)
framingRender :: forall (m :: Type -> Type) a. (FramingRender strategy, Monad m) => Proxy strategy -> (a -> ByteString) -> SourceT m a -> SourceT m ByteString

-- | The FramingUnrender class provides the logic for parsing a
--   framing strategy.
class FramingUnrender (strategy :: k)
framingUnrender :: forall (m :: Type -> Type) a. (FramingUnrender strategy, Monad m) => Proxy strategy -> (ByteString -> Either String a) -> SourceT m ByteString -> SourceT m a

-- | A framing strategy that does not do any framing at all, it just passes
--   the input data This will be used most of the time with binary data,
--   such as files
data NoFraming

-- | A simple framing strategy that has no header, and inserts a newline
--   character after each frame. This assumes that it is used with a
--   Content-Type that encodes without newlines (e.g. JSON).
data NewlineFraming

-- | The netstring framing strategy as defined by djb:
--   http://cr.yp.to/proto/netstrings.txt
--   
--   Any string of 8-bit bytes may be encoded as
--   [len]":"[string]",". Here [string] is the string and
--   [len] is a nonempty sequence of ASCII digits giving the
--   length of [string] in decimal. The ASCII digits are
--   30 for 0, 31 for 1, and so on up
--   through 39 for 9. Extra zeros at the front of
--   [len] are prohibited: [len] begins with
--   30 exactly when [string] is empty.
--   
--   For example, the string "hello world!" is encoded as
--   32 3a 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 2c, i.e.,
--   "12:hello world!,". The empty string is encoded as
--   "0:,".
data NetstringFraming
instance Servant.API.Stream.FramingRender Servant.API.Stream.NetstringFraming
instance Servant.API.Stream.FramingRender Servant.API.Stream.NewlineFraming
instance Servant.API.Stream.FramingRender Servant.API.Stream.NoFraming
instance Servant.API.Stream.FramingUnrender Servant.API.Stream.NetstringFraming
instance Servant.API.Stream.FramingUnrender Servant.API.Stream.NewlineFraming
instance Servant.API.Stream.FramingUnrender Servant.API.Stream.NoFraming
instance Control.Monad.IO.Class.MonadIO m => Servant.API.Stream.FromSourceIO a (Servant.Types.SourceT.SourceT m a)
instance forall k1 (method :: k1) (status :: GHC.Internal.TypeNats.Nat) framing contentType a. GHC.Internal.Generics.Generic (Servant.API.Stream.Stream method status framing contentType a)
instance GHC.Internal.Generics.Generic (Servant.API.Stream.StreamBody' mods framing contentType a)
instance Servant.API.Stream.SourceToSourceIO GHC.Types.IO
instance Servant.API.Stream.ToSourceIO a [a]
instance Servant.API.Stream.ToSourceIO a (GHC.Internal.Base.NonEmpty a)
instance Servant.API.Stream.SourceToSourceIO m => Servant.API.Stream.ToSourceIO chunk (Servant.Types.SourceT.SourceT m chunk)

-- | MultiVerb is a part of the type-level eDSL that allows you to express
--   complex routes while retaining a high level of precision with good
--   ergonomics.
module Servant.API.MultiVerb

-- | MultiVerb produces an endpoint which can return multiple values
--   with various content types and status codes. It is similar to
--   UVerb and behaves similarly, but it has some important
--   differences:
--   
--   
--   
- Descriptions and statuses can be attached to individual responses
--   without using wrapper types and without affecting the handler return
--   type.
--   
- The return type of the handler can be decoupled from the types of
--   the individual responses. One can use a Union type just like
--   for UVerb, but MultiVerb also supports using an
--   arbitrary type with an AsUnion instance. Each response is
--   responsible for their content type.
--   
- Headers can be attached to individual responses, also without
--   affecting the handler return type.
--   
--   
--   
Example
--   
--   Let us create an endpoint that captures an Int and has the
--   following logic:
--   
--   
--   
- If the number is negative, we return status code 400 and an empty
--   body;
--   
- If the number is even, we return a Bool in the response
--   body;
--   
- If the number is odd, we return another Int in the response
--   body.
--   
--   
--   
--   import qualified Generics.SOP as GSOP
--   
--   
--   
--   -- All possible HTTP responses
--   type Responses =
--     '[ type RespondEmpty 400 "Negative"
--      , type Respond 200 "Even number" Bool
--      , type Respond 200 "Odd number" Int
--      ]
--   
--   -- All possible return types
--   data Result
--     = NegativeNumber
--     | Odd Int
--     | Even Bool
--     deriving stock (Generic)
--     deriving (AsUnion Responses)
--       via GenericAsUnion Responses Result
--   
--   instance GSOP.Generic Result
--   
--   
--   These deriving statements above tie together the responses and the
--   return values, and the order in which they are defined matters. For
--   instance, if Even and Odd had switched places in the
--   definition of Result, this would provoke an error:
--   
--   
--   • No instance for ‘AsConstructor
--       ((:) @Type Int ('[] @Type)) (Respond 200 "Even number" Bool)’
--           arising from the 'deriving' clause of a data type declaration
--   
--   
--   If you would prefer to write an intance of AsUnion by yourself,
--   read more in the typeclass' documentation.
--   
--   Finally, let us write our endpoint description:
--   
--   
--   type MultipleChoicesInt =
--     Capture "int" Int
--     :> MultiVerb
--       'GET
--       '[JSON]
--       Responses
--       Result
--   
data MultiVerb (method :: StdMethod) (requestMimeTypes :: k) (as :: [Type]) responses

-- | A MultiVerb endpoint with a single response. Ideal to ensure
--   that there can only be one response.
type MultiVerb1 (method :: StdMethod) (requestMimeTypes :: k) a = MultiVerb method requestMimeTypes '[a] ResponseType a

-- | A type to describe a MultiVerb response.
--   
--   Includes status code, description, and return type. The content type
--   of the response is determined dynamically using the accept header and
--   the list of supported content types specified in the containing
--   MultiVerb type.
data Respond (s :: Nat) (description :: Symbol) a

-- | A type to describe a MultiVerb response with a fixed content
--   type.
--   
--   Similar to Respond, but hardcodes the content type to be used
--   for generating the response. This content type is distinct from the
--   one given to MultiVerb, as it dictactes the response's content
--   type, not the content type request that is to be accepted.
data RespondAs (responseContentType :: k) (s :: Nat) (description :: Symbol) a

-- | A type to describe a MultiVerb response with an empty body.
--   
--   Includes status code and description.
type RespondEmpty (s :: Nat) (description :: Symbol) = RespondAs '() s description ()

-- | A type to describe a streaming MultiVerb response.
--   
--   Includes status code, description, framing strategy and content type.
--   Note that the handler return type is hardcoded to be 'SourceIO
--   ByteString'.
data RespondStreaming (s :: Nat) (description :: Symbol) framing ct

-- | This type adds response headers to a MultiVerb response.
data WithHeaders (headers :: [Type]) returnType response
data DescHeader (name :: Symbol) (description :: Symbol) a

-- | A wrapper to turn a response header into an optional one.
data OptHeader (h :: k)

-- | This is used to convert a response containing headers to a custom type
--   including the information in the headers.
--   
--   If you need to send a combination of headers and response that is not
--   provided by Servant, you can cwrite your own instance. Take example on
--   the ones provided.
class AsHeaders (headers :: [Type]) response returnType
fromHeaders :: AsHeaders headers response returnType => (NP I headers, response) -> returnType
toHeaders :: AsHeaders headers response returnType => returnType -> (NP I headers, response)
class ServantHeaders (headers :: k) (xs :: [Type]) | headers -> xs
constructHeaders :: ServantHeaders headers xs => NP I xs -> [Header]
extractHeaders :: ServantHeaders headers xs => Seq Header -> Maybe (NP I xs)
class ServantHeader (h :: k) (name :: Symbol) x | h -> name x
constructHeader :: ServantHeader h name x => x -> [Header]

-- | This class is used to convert a handler return type to a union type
--   including all possible responses of a MultiVerb endpoint.
--   
--   Any glue code necessary to convert application types to and from the
--   canonical Union type corresponding to a MultiVerb
--   endpoint should be packaged into an AsUnion instance.
--   
--   
Example
--   
--   Let us take the example endpoint from the MultiVerb
--   documentation. There, we derived the AsUnion instance with the
--   help of Generics. The manual way of implementing the instance is:
--   
--   
--   instance AsUnion Responses Result where
--     toUnion NegativeNumber = Z (I ())
--     toUnion (Even b) = S (Z (I b))
--     toUnion (Odd i) = S (S (Z (I i)))
--   
--     fromUnion       (Z (I ())) = NegativeNumber
--     fromUnion    (S (Z (I b))) = Even b
--     fromUnion (S (S (Z (I i)))) = Odd i
--     fromUnion (S (S (S x))) = case x of {}
--   
--   
--   The last fromUnion equation is here to please the pattern
--   checker.
class AsUnion (as :: [Type]) r
toUnion :: AsUnion as r => r -> Union (ResponseTypes as)
fromUnion :: AsUnion as r => Union (ResponseTypes as) -> r
eitherToUnion :: forall (as :: [Type]) (bs :: [Type]) a b. (InjectAfter as bs, InjectBefore as bs) => (a -> Union as) -> (b -> Union bs) -> Either a b -> Union (as .++ bs)
eitherFromUnion :: EitherFromUnion as bs => (Union as -> a) -> (Union bs -> b) -> Union (as .++ bs) -> Either a b
maybeToUnion :: forall (as :: [Type]) a. (InjectAfter as '[()], InjectBefore as '[()]) => (a -> Union as) -> Maybe a -> Union (as .++ '[()])
maybeFromUnion :: forall (as :: [Type]) a. EitherFromUnion as '[()] => (Union as -> a) -> Union (as .++ '[()]) -> Maybe a

-- | This class can be instantiated to get automatic derivation of
--   AsUnion instances via GenericAsUnion. The idea is that
--   one has to make sure that for each response r in a
--   MultiVerb endpoint, there is an instance of AsConstructor
--   xs r for some xs, and that the list xss of all
--   the corresponding xs is equal to Code of the handler
--   type. Then one can write: @ type Responses = ... data Result = ...
--   deriving stock (Generic) deriving (AsUnion Responses) via
--   (GenericAsUnion Responses Result)
--   
--   instance GSOP.Generic Result @ and get an AsUnion instance for
--   free.
--   
--   There are a few predefined instances for constructors taking a single
--   type corresponding to a simple response, and for empty responses, but
--   in more general cases one either has to define an AsConstructor
--   instance by hand, or derive it via GenericAsConstructor.
class AsConstructor (xs :: [Type]) r
toConstructor :: AsConstructor xs r => ResponseType r -> NP I xs
fromConstructor :: AsConstructor xs r => NP I xs -> ResponseType r
newtype GenericAsConstructor r
GenericAsConstructor :: r -> GenericAsConstructor r

-- | This type is meant to be used with deriving via in order to
--   automatically generate an AsUnion instance using SOP.
--   
--   See AsConstructor for more information and examples.
newtype GenericAsUnion (rs :: k) a
GenericAsUnion :: a -> GenericAsUnion (rs :: k) a
type family ResponseType a
type family ResponseTypes (as :: [Type]) :: [Type]

-- | The result of parsing a response as a union alternative of type
--   a.
--   
--   StatusMismatch indicates that the response does not refer to
--   the given alternative, because the status code does not match the one
--   produced by that alternative.
--   
--   UnrenderError and UnrenderSuccess represent respectively
--   a failing and successful parse of the response body as a value of type
--   a.
--   
--   The UnrenderResult type constructor has monad and alternative
--   instances corresponding to those of 'Either (Maybe (Last String)) a'.
data UnrenderResult a
StatusMismatch :: UnrenderResult a
UnrenderError :: String -> UnrenderResult a
UnrenderSuccess :: a -> UnrenderResult a
instance GHC.Internal.Base.Alternative Servant.API.MultiVerb.UnrenderResult
instance GHC.Internal.Base.Applicative Servant.API.MultiVerb.UnrenderResult
instance (Servant.API.MultiVerb.AsConstructor xs r, Servant.API.MultiVerb.AsConstructors xss rs) => Servant.API.MultiVerb.AsConstructors (xs : xss) (r : rs)
instance Servant.API.MultiVerb.AsConstructors '[] '[]
instance Servant.API.MultiVerb.AsConstructor '[a] (Servant.API.MultiVerb.Respond code description a)
instance Servant.API.MultiVerb.AsConstructor '[a] (Servant.API.MultiVerb.RespondAs responseContentTypes code description a)
instance Servant.API.MultiVerb.AsConstructor '[a] (Servant.API.MultiVerb.WithHeaders headers a response)
instance Servant.API.MultiVerb.AsConstructor '[] (Servant.API.MultiVerb.RespondEmpty code description)
instance (Generics.SOP.Universe.Code (Servant.API.MultiVerb.ResponseType r) GHC.Types.~ '[xs], Generics.SOP.Universe.Generic (Servant.API.MultiVerb.ResponseType r)) => Servant.API.MultiVerb.AsConstructor xs (Servant.API.MultiVerb.GenericAsConstructor r)
instance Servant.API.MultiVerb.AsHeaders '[a, b] () (a, b)
instance Servant.API.MultiVerb.AsHeaders '[a] () a
instance Servant.API.MultiVerb.AsHeaders '[h] a (a, h)
instance Servant.API.MultiVerb.AsUnion '[Servant.API.MultiVerb.RespondEmpty s1 desc1, Servant.API.MultiVerb.RespondEmpty s2 desc2] GHC.Types.Bool
instance (Servant.API.MultiVerb.ResponseType r1 GHC.Types.~ (), Servant.API.MultiVerb.ResponseType r2 GHC.Types.~ a) => Servant.API.MultiVerb.AsUnion '[r1, r2] (GHC.Internal.Maybe.Maybe a)
instance (Servant.API.MultiVerb.ResponseType r GHC.Types.~ a) => Servant.API.MultiVerb.AsUnion '[r] a
instance (rs GHC.Types.~ Servant.API.MultiVerb.ResponseTypes as) => Servant.API.MultiVerb.AsUnion as (Servant.API.UVerb.Union.Union rs)
instance (Generics.SOP.Universe.Code a GHC.Types.~ xss, Generics.SOP.Universe.Generic a, Servant.API.MultiVerb.AsConstructors xss rs) => Servant.API.MultiVerb.AsUnion rs (Servant.API.MultiVerb.GenericAsUnion rs a)
instance Servant.API.MultiVerb.EitherFromUnion as bs => Servant.API.MultiVerb.EitherFromUnion (a : as) bs
instance Servant.API.MultiVerb.EitherFromUnion '[] bs
instance GHC.Classes.Eq a => GHC.Classes.Eq (Servant.API.MultiVerb.UnrenderResult a)
instance GHC.Internal.Base.Functor Servant.API.MultiVerb.UnrenderResult
instance Servant.API.MultiVerb.InjectAfter as bs => Servant.API.MultiVerb.InjectAfter (a : as) bs
instance Servant.API.MultiVerb.InjectAfter '[] bs
instance Servant.API.MultiVerb.InjectBefore as bs => Servant.API.MultiVerb.InjectBefore (a : as) bs
instance Servant.API.MultiVerb.InjectBefore '[] bs
instance GHC.Internal.Base.MonadPlus Servant.API.MultiVerb.UnrenderResult
instance GHC.Internal.Base.Monad Servant.API.MultiVerb.UnrenderResult
instance (GHC.Internal.TypeLits.KnownSymbol name, Web.Internal.HttpApiData.ToHttpApiData x) => Servant.API.MultiVerb.ServantHeader (Servant.API.MultiVerb.DescHeader name description x) name x
instance (GHC.Internal.TypeLits.KnownSymbol name, Web.Internal.HttpApiData.ToHttpApiData x) => Servant.API.MultiVerb.ServantHeader (Servant.API.Header.Header' mods name x) name x
instance forall k (h :: k) (name :: GHC.Types.Symbol) x. Servant.API.MultiVerb.ServantHeader h name x => Servant.API.MultiVerb.ServantHeader (Servant.API.MultiVerb.OptHeader h) name (GHC.Internal.Maybe.Maybe x)
instance forall a (name :: GHC.Types.Symbol) (h :: a) x (headers :: [a]) (xs :: [GHC.Types.Type]). (GHC.Internal.TypeLits.KnownSymbol name, Servant.API.MultiVerb.ServantHeader h name x, Web.Internal.HttpApiData.FromHttpApiData x, Servant.API.MultiVerb.ServantHeaders headers xs) => Servant.API.MultiVerb.ServantHeaders (h : headers) (x : xs)
instance Servant.API.MultiVerb.ServantHeaders '[] '[]
instance GHC.Internal.Show.Show a => GHC.Internal.Show.Show (Servant.API.MultiVerb.UnrenderResult a)

-- | Type safe generation of internal links.
--   
--   Given an API with a few endpoints:
--   
--   
--   >>> :set -XDataKinds -XTypeFamilies -XTypeOperators -XPolyKinds
--   
--   >>> import Servant.API
--   
--   >>> import Servant.Links
--   
--   >>> import Web.HttpApiData (toUrlPiece)
--   
--   >>> import Data.Proxy
--   
--   >>> 
--   
--   >>> type Hello = "hello" :> Get '[JSON] Int
--   
--   >>> type Bye   = "bye"   :> QueryParam "name" String :> Delete '[JSON] NoContent
--   
--   >>> type API   = Hello :<|> Bye
--   
--   >>> let api = Proxy :: Proxy API
--   
--   
--   It is possible to generate links that are guaranteed to be within
--   API with safeLink. The first argument to
--   safeLink is a type representing the API you would like to
--   restrict links to. The second argument is the destination endpoint you
--   would like the link to point to, this will need to end with a verb
--   like GET or POST. Further arguments may be required depending on the
--   type of the endpoint. If everything lines up you will get a
--   Link out the other end.
--   
--   You may omit QueryParams and the like should you not want to
--   provide them, but types which form part of the URL path like
--   Capture must be included. The reason you may want to omit
--   QueryParams is that safeLink is a bit magical: if parameters
--   are included that could take input it will return a function that
--   accepts that input and generates a link. This is best shown with an
--   example. Here, a link is generated with no parameters:
--   
--   
--   >>> let hello = Proxy :: Proxy ("hello" :> Get '[JSON] Int)
--   
--   >>> toUrlPiece (safeLink api hello :: Link)
--   "hello"
--   
--   
--   If the API has an endpoint with parameters then we can generate links
--   with or without those:
--   
--   
--   >>> let with = Proxy :: Proxy ("bye" :> QueryParam "name" String :> Delete '[JSON] NoContent)
--   
--   >>> toUrlPiece $ safeLink api with (Just "Hubert")
--   "bye?name=Hubert"
--   
--   
--   
--   >>> let without = Proxy :: Proxy ("bye" :> Delete '[JSON] NoContent)
--   
--   >>> toUrlPiece $ safeLink api without
--   "bye"
--   
--   
--   If you would like to create a helper for generating links only within
--   that API, you can partially apply safeLink if you specify a correct
--   type signature like so:
--   
--   
--   >>> :set -XConstraintKinds
--   
--   >>> :{
--   
--   >>> let apiLink :: (IsElem endpoint API, HasLink endpoint)
--   
--   >>>             => Proxy endpoint -> MkLink endpoint Link
--   
--   >>>     apiLink = safeLink api
--   
--   >>> :}
--   
--   
--   safeLink' allows you to specialise the output:
--   
--   
--   >>> safeLink' toUrlPiece api without
--   "bye"
--   
--   
--   
--   >>> :{
--   
--   >>> let apiTextLink :: (IsElem endpoint API, HasLink endpoint)
--   
--   >>>                  => Proxy endpoint -> MkLink endpoint Text
--   
--   >>>     apiTextLink = safeLink' toUrlPiece api
--   
--   >>> :}
--   
--   
--   
--   >>> apiTextLink without
--   "bye"
--   
--   
--   Attempting to construct a link to an endpoint that does not exist in
--   api will result in a type error like this:
--   
--   
--   >>> let bad_link = Proxy :: Proxy ("hello" :> Delete '[JSON] NoContent)
--   
--   >>> safeLink api bad_link
--   ...
--   ...Could not ...
--   ...
--   
--   
--   This error is essentially saying that the type family couldn't find
--   bad_link under api after trying the open (but empty) type family
--   IsElem' as a last resort.
module Servant.Links

-- | Create a valid (by construction) relative URI with query params.
--   
--   This function will only typecheck if endpoint is part of the
--   API api
safeLink :: (IsElem endpoint api, HasLink endpoint) => Proxy api -> Proxy endpoint -> MkLink endpoint Link

-- | More general safeLink.
safeLink' :: (IsElem endpoint api, HasLink endpoint) => (Link -> a) -> Proxy api -> Proxy endpoint -> MkLink endpoint a

-- | Create all links in an API.
--   
--   Note that the api type must be restricted to the endpoints
--   that have valid links to them.
--   
--   
--   >>> type API = "foo" :> Capture "name" Text :> Get '[JSON] Text :<|> "bar" :> Capture "name" Int :> Get '[JSON] Double
--   
--   >>> let fooLink :<|> barLink = allLinks (Proxy :: Proxy API)
--   
--   >>> :t fooLink
--   fooLink :: Text -> Link
--   
--   >>> :t barLink
--   barLink :: Int -> Link
--   
--   
--   Note: nested APIs don't work well with this approach
--   
--   
--   >>> :kind! MkLink (Capture "nest" Char :> (Capture "x" Int :> Get '[JSON] Int :<|> Capture "y" Double :> Get '[JSON] Double)) Link
--   MkLink (Capture "nest" Char :> (Capture "x" Int :> Get '[JSON] Int :<|> Capture "y" Double :> Get '[JSON] Double)) Link :: Type
--   = Char -> (Int -> Link) :<|> (Double -> Link)
--   
allLinks :: forall {k} (api :: k). HasLink api => Proxy api -> MkLink api Link

-- | More general allLinks. See safeLink'.
allLinks' :: forall {k} (api :: k) a. HasLink api => (Link -> a) -> Proxy api -> MkLink api a

-- | Represents a general universal resource identifier using its component
--   parts.
--   
--   For example, for the URI
--   
--   
--   foo://anonymous@www.haskell.org:42/ghc?query#frag
--   
--   
--   the components are:
data URI
URI :: String -> Maybe URIAuth -> String -> String -> String -> URI

-- | 
--   foo:
--   
[uriScheme] :: URI -> String

-- | 
--   //anonymous@www.haskell.org:42
--   
[uriAuthority] :: URI -> Maybe URIAuth

-- | 
--   /ghc
--   
[uriPath] :: URI -> String

-- | 
--   ?query
--   
[uriQuery] :: URI -> String

-- | 
--   #frag
--   
[uriFragment] :: URI -> String

-- | A type that specifies that an API record contains a set of links.
data AsLink a

-- | Given an API record field, create a link for that route. Only the
--   field's type is used.
--   
--   
--   data Record route = Record
--       { _get :: route :- Capture "id" Int :> Get '[JSON] String
--       , _put :: route :- ReqBody '[JSON] Int :> Put '[JSON] Bool
--       }
--     deriving (Generic)
--   
--   getLink :: Int -> Link
--   getLink = fieldLink _get
--   
fieldLink :: (IsElem endpoint (ToServantApi routes), HasLink endpoint, GenericServant routes AsApi) => (routes AsApi -> endpoint) -> MkLink endpoint Link

-- | More general version of fieldLink
fieldLink' :: forall routes endpoint a. (IsElem endpoint (ToServantApi routes), HasLink endpoint, GenericServant routes AsApi) => (Link -> a) -> (routes AsApi -> endpoint) -> MkLink endpoint a

-- | Get all links as a record.
allFieldLinks :: (HasLink (ToServantApi routes), GenericServant routes (AsLink Link), ToServant routes (AsLink Link) ~ MkLink (ToServantApi routes) Link) => routes (AsLink Link)

-- | More general version of allFieldLinks.
allFieldLinks' :: (HasLink (ToServantApi routes), GenericServant routes (AsLink a), ToServant routes (AsLink a) ~ MkLink (ToServantApi routes) a) => (Link -> a) -> routes (AsLink a)

-- | Construct a toLink for an endpoint.
class HasLink (endpoint :: k) where {
    type MkLink (endpoint :: k) a;
}
toLink :: HasLink endpoint => (Link -> a) -> Proxy endpoint -> Link -> MkLink endpoint a

-- | A safe link datatype. The only way of constructing a Link is
--   using safeLink, which means any Link is guaranteed to be
--   part of the mentioned API.
--   
--   NOTE: If you are writing a custom HasLink instance, and need to
--   manipulate the Link (adding query params or fragments,
--   perhaps), please use the the addQueryParam and
--   addSegment functions.
data Link

-- | Transform Link into URI.
--   
--   
--   >>> type API = "something" :> Get '[JSON] Int
--   
--   >>> linkURI $ safeLink (Proxy :: Proxy API) (Proxy :: Proxy API)
--   something
--   
--   
--   
--   >>> type API = "sum" :> QueryParams "x" Int :> Get '[JSON] Int
--   
--   >>> linkURI $ safeLink (Proxy :: Proxy API) (Proxy :: Proxy API) [1, 2, 3]
--   sum?x[]=1&x[]=2&x[]=3
--   
--   
--   
--   >>> type API = "foo/bar" :> Get '[JSON] Int
--   
--   >>> linkURI $ safeLink (Proxy :: Proxy API) (Proxy :: Proxy API)
--   foo%2Fbar
--   
--   
--   
--   >>> type SomeRoute = "abc" :> Capture "email" String :> Put '[JSON] ()
--   
--   >>> let someRoute = Proxy :: Proxy SomeRoute
--   
--   >>> safeLink someRoute someRoute "test@example.com"
--   Link {_segments = ["abc","test%40example.com"], _queryParams = [], _fragment = Nothing}
--   
--   
--   
--   >>> linkURI $ safeLink someRoute someRoute "test@example.com"
--   abc/test%40example.com
--   
linkURI :: Link -> URI

-- | Configurable linkURI.
--   
--   
--   >>> type API = "sum" :> QueryParams "x" Int :> Get '[JSON] Int
--   
--   >>> linkURI' LinkArrayElementBracket $ safeLink (Proxy :: Proxy API) (Proxy :: Proxy API) [1, 2, 3]
--   sum?x[]=1&x[]=2&x[]=3
--   
--   
--   
--   >>> linkURI' LinkArrayElementPlain $ safeLink (Proxy :: Proxy API) (Proxy :: Proxy API) [1, 2, 3]
--   sum?x=1&x=2&x=3
--   
linkURI' :: LinkArrayElementStyle -> Link -> URI

-- | How to encode array query elements.
data LinkArrayElementStyle

-- | 
--   foo[]=1&foo[]=2
--   
LinkArrayElementBracket :: LinkArrayElementStyle

-- | 
--   foo=1&foo=2
--   
LinkArrayElementPlain :: LinkArrayElementStyle

-- | Query parameter.
data Param
SingleParam :: String -> Text -> Param
ArrayElemParam :: String -> Text -> Param
FlagParam :: String -> Param
linkSegments :: Link -> [String]
linkQueryParams :: Link -> [Param]
linkFragment :: Link -> Fragment'

-- | Add a Param (query param) to a Link
--   
--   Please use this judiciously from within your custom HasLink
--   instances to ensure that you don't end-up breaking the safe provided
--   by "safe links"
addQueryParam :: Param -> Link -> Link
instance GHC.Internal.Enum.Bounded Servant.Links.LinkArrayElementStyle
instance GHC.Internal.Enum.Enum Servant.Links.LinkArrayElementStyle
instance GHC.Classes.Eq Servant.Links.LinkArrayElementStyle
instance Servant.Links.GLinkConstraints routes a => Servant.Links.GLink routes a
instance Servant.API.Generic.GenericMode (Servant.Links.AsLink a)
instance (Servant.Links.HasLink a, Servant.Links.HasLink b) => Servant.Links.HasLink (a Servant.API.Alternative.:<|> b)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.Description.Summary s Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Network.HTTP.Types.Version.HttpVersion Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.IsSecure.IsSecure Servant.API.Sub.:> sub)
instance forall k sub (res :: k). Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.WithResource.WithResource res Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.RemoteHost.RemoteHost Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.BasicAuth.BasicAuth realm a Servant.API.Sub.:> sub)
instance forall k sub (tag :: k). Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.Experimental.Auth.AuthProtect tag Servant.API.Sub.:> sub)
instance (GHC.Internal.TypeLits.KnownSymbol sym, Servant.Links.HasLink sub) => Servant.Links.HasLink (sym Servant.API.Sub.:> sub)
instance (Servant.Links.HasLink sub, Web.Internal.HttpApiData.ToHttpApiData v) => Servant.Links.HasLink (Servant.API.Fragment.Fragment v Servant.API.Sub.:> sub)
instance (GHC.Internal.TypeLits.KnownSymbol sym, Web.Internal.HttpApiData.ToHttpApiData v, Servant.Links.HasLink sub, Data.Singletons.Bool.SBoolI (Servant.API.Modifiers.FoldRequired mods)) => Servant.Links.HasLink (Servant.API.QueryParam.QueryParam' mods sym v Servant.API.Sub.:> sub)
instance (GHC.Internal.TypeLits.KnownSymbol sym, Web.Internal.HttpApiData.ToHttpApiData v, Servant.Links.HasLink sub) => Servant.Links.HasLink (Servant.API.QueryParam.QueryParams sym v Servant.API.Sub.:> sub)
instance (GHC.Internal.TypeLits.KnownSymbol sym, Servant.Links.HasLink sub) => Servant.Links.HasLink (Servant.API.QueryParam.QueryFlag sym Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.ReqBody.ReqBody' mods ct a Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.Stream.StreamBody' mods framing ct a Servant.API.Sub.:> sub)
instance (Web.Internal.HttpApiData.ToHttpApiData v, Servant.Links.HasLink sub) => Servant.Links.HasLink (Servant.API.Capture.Capture' mods sym v Servant.API.Sub.:> sub)
instance (Web.Internal.HttpApiData.ToHttpApiData v, Servant.Links.HasLink sub) => Servant.Links.HasLink (Servant.API.Capture.CaptureAll sym v Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.Header.Header' mods sym a Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Data.Vault.Lazy.Vault Servant.API.Sub.:> sub)
instance Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.Description.Description s Servant.API.Sub.:> sub)
instance forall a b (arr :: a -> b) sub. (TypeError ...) => Servant.Links.HasLink (arr Servant.API.Sub.:> sub)
instance forall k (ty :: k) sub. (TypeError ...) => Servant.Links.HasLink (ty Servant.API.Sub.:> sub)
instance (GHC.Internal.TypeLits.KnownSymbol sym, Servant.API.QueryString.ToDeepQuery record, Servant.Links.HasLink sub) => Servant.Links.HasLink (Servant.API.QueryString.DeepQuery sym record Servant.API.Sub.:> sub)
instance Servant.Links.HasLink Servant.API.Empty.EmptyAPI
instance forall k (method :: Network.HTTP.Types.Method.StdMethod) (cs :: k) (as :: [GHC.Types.Type]) r. Servant.Links.HasLink (Servant.API.MultiVerb.MultiVerb method cs as r)
instance (Servant.Links.HasLink (Servant.API.Generic.ToServantApi routes), forall a. Servant.Links.GLink routes a, Servant.API.TypeErrors.ErrorIfNoGeneric routes) => Servant.Links.HasLink (Servant.API.NamedRoutes.NamedRoutes routes)
instance forall k1 (m :: k1). Servant.Links.HasLink (Servant.API.Verbs.NoContentVerb m)
instance Servant.Links.HasLink Servant.API.Raw.Raw
instance Servant.Links.HasLink Servant.API.Raw.RawM
instance forall k1 (m :: k1) (status :: GHC.Internal.TypeNats.Nat) fr ct a. Servant.Links.HasLink (Servant.API.Stream.Stream m status fr ct a)
instance Servant.Links.HasLink (Servant.API.UVerb.UVerb m ct a)
instance forall k1 (m :: k1) (s :: GHC.Internal.TypeNats.Nat) (ct :: [GHC.Types.Type]) a. Servant.Links.HasLink (Servant.API.Verbs.Verb m s ct a)
instance forall k (sub :: k) (name :: GHC.Types.Symbol) (context :: [GHC.Types.Type]). Servant.Links.HasLink sub => Servant.Links.HasLink (Servant.API.WithNamedContext.WithNamedContext name context sub)
instance forall k (api :: k). (TypeError ...) => Servant.Links.HasLink api
instance GHC.Classes.Ord Servant.Links.LinkArrayElementStyle
instance GHC.Internal.Show.Show Servant.Links.Escaped
instance GHC.Internal.Show.Show Servant.Links.Link
instance GHC.Internal.Show.Show Servant.Links.LinkArrayElementStyle
instance GHC.Internal.Show.Show Servant.Links.Param
instance Web.Internal.HttpApiData.ToHttpApiData Servant.Links.Link

module Servant.API

-- | Strictly parsed argument. Not wrapped.
data Strict

-- | Leniently parsed argument, i.e. parsing never fail. Wrapped in
--   Either Text.
data Lenient

-- | Optional argument. Wrapped in Maybe.
data Optional

-- | Required argument. Not wrapped.
data Required

-- | Extract the whole query string from a request. This is useful for
--   query strings containing dynamic parameter names. For query strings
--   with static parameter names, QueryParam is more suited.
--   
--   Example:
--   
--   
--   >>> -- /books?author=<author name>&year=<book year>
--   
--   >>> type MyApi = "books" :> QueryString :> Get '[JSON] [Book]
--   
data QueryString

-- | Extract an deep object from a query string.
--   
--   Example:
--   
--   
--   >>> -- /books?filter[author][name]=<author name>&filter[year]=<book year>
--   
--   >>> type MyApi = "books" :> DeepQuery "filter" BookQuery :> Get '[JSON] [Book]
--   
data DeepQuery (sym :: Symbol) a

-- | GET with 200 status code.
type Get = Verb 'GET 200

-- | PUT with 200 status code.
type Put = Verb 'PUT 200

-- | HTTP standard method (as defined by RFC 2616, and PATCH which is
--   defined by RFC 5789).
data StdMethod
GET :: StdMethod
POST :: StdMethod
HEAD :: StdMethod
PUT :: StdMethod
DELETE :: StdMethod
TRACE :: StdMethod
CONNECT :: StdMethod
OPTIONS :: StdMethod

PATCH :: StdMethod

-- | DELETE with 200 status code.
type Delete = Verb 'DELETE 200

-- | DELETE with 202 status code.
type DeleteAccepted = Verb 'DELETE 202

-- | DELETE with 204 status code.
type DeleteNoContent = NoContentVerb 'DELETE

-- | DELETE with 203 status code.
type DeleteNonAuthoritative = Verb 'DELETE 203

-- | GET with 202 status code.
type GetAccepted = Verb 'GET 202

-- | GET with 204 status code.
type GetNoContent = NoContentVerb 'GET

-- | GET with 203 status code.
type GetNonAuthoritative = Verb 'GET 203

-- | GET with 206 status code.
type GetPartialContent = Verb 'GET 206

-- | GET with 205 status code.
type GetResetContent = Verb 'GET 205

-- | NoContentVerb is a specific type to represent
--   NoContent responses. It does not require either a list of
--   content types (because there's no content) or a status code (because
--   it should always be 204).
data NoContentVerb (method :: k1)

-- | PATCH with 200 status code.
type Patch = Verb 'PATCH 200

-- | PATCH with 202 status code.
type PatchAccepted = Verb 'PATCH 202

-- | PATCH with 204 status code.
type PatchNoContent = NoContentVerb 'PATCH

-- | PATCH with 203 status code.
type PatchNonAuthoritative = Verb 'PATCH 203

-- | POST with 200 status code.
type Post = Verb 'POST 200

-- | POST with 202 status code.
type PostAccepted = Verb 'POST 202

-- | POST with 201 status code.
type PostCreated = Verb 'POST 201

-- | POST with 204 status code.
type PostNoContent = NoContentVerb 'POST

-- | POST with 203 status code.
type PostNonAuthoritative = Verb 'POST 203

-- | POST with 205 status code.
type PostResetContent = Verb 'POST 205

-- | PUT with 202 status code.
type PutAccepted = Verb 'PUT 202

-- | PUT with 201 status code.
type PutCreated = Verb 'PUT 201

-- | PUT with 204 status code.
type PutNoContent = NoContentVerb 'PUT

-- | PUT with 203 status code.
type PutNonAuthoritative = Verb 'PUT 203
class ReflectMethod (a :: k)
reflectMethod :: ReflectMethod a => Proxy a -> Method

-- | Verb is a general type for representing HTTP verbs (a.k.a.
--   methods). For convenience, type synonyms for each verb with a 200
--   response code are provided, but you are free to define your own:
--   
--   
--   >>> type Post204 contentTypes a = Verb 'POST 204 contentTypes a
--   
data Verb (method :: k1) (statusCode :: Nat) (contentTypes :: [Type]) a

-- | Check whether all values in a type-level list are distinct. This will
--   throw a nice error if there are any duplicate elements in the list.
type family Unique (xs :: [k])
type Union = NS I

-- | A variant of Verb that can have any of a number of response
--   values and status codes.
--   
--   FUTUREWORK: it would be nice to make Verb a special case of
--   UVerb, and only write instances for HasServer etc. for
--   the latter, getting them for the former for free. Something like:
--   
--   
--   type Verb method statusCode contentTypes a = UVerb method contentTypes [WithStatus statusCode a]
--   
--   
--   Backwards compatibility is tricky, though: this type alias would mean
--   people would have to use respond instead of pure or
--   return, so all old handlers would have to be rewritten.
data UVerb (method :: StdMethod) (contentTypes :: [Type]) (as :: [Type])
class KnownStatus StatusOf a => HasStatus a where {
    type StatusOf a :: Nat;
}
type IsMember (a :: u) (as :: [u]) = (Unique as, CheckElemIsMember a as, UElem a as)
type family StatusOf a :: Nat
type family Statuses (as :: [Type]) :: [Nat]
type family Statuses (as :: [Type]) :: [Nat]

-- | A simple newtype wrapper that pairs a type with its status code. It
--   implements all the content types that Servant ships with by default.
newtype WithStatus (k :: Nat) a
WithStatus :: a -> WithStatus (k :: Nat) a
inject :: UElem x xs => f x -> NS f xs
statusOf :: HasStatus a => proxy a -> Status

-- | A class with a type family that applies an appropriate type family to
--   the api parameter. For example, AsApi will leave
--   api untouched, while AsServerT m will
--   produce ServerT api m.
class GenericMode (mode :: k) where {
    type (mode :: k) :- api;
}
infixl 0 :-
type family (mode :: k) :- api
infixl 0 :-

-- | A type that specifies that an API record contains an API definition.
--   Only useful at type-level.
data AsApi
class GServantProduct (f :: k -> Type)

-- | A constraint alias, for work with mode and routes.
type GenericServant (routes :: k -> Type) (mode :: k) = (GenericMode mode, Generic routes mode, GServantProduct Rep routes mode)

-- | Turns a generic product type into a tree of :<|>
--   combinators.
type ToServant (routes :: k -> Type) (mode :: k) = GToServant Rep routes mode
type ToServantApi (routes :: Type -> Type) = ToServant routes AsApi

-- | Inverse of toServant.
--   
--   This can be used to turn generated values such as client
--   functions into records.
--   
--   You may need to provide a type signature for the output type
--   (your record type).
fromServant :: forall {k} routes (mode :: k). GenericServant routes mode => ToServant routes mode -> routes mode

-- | Get a Proxy of an API type.
genericApi :: forall (routes :: Type -> Type). GenericServant routes AsApi => Proxy routes -> Proxy (ToServantApi routes)

-- | See ToServant, but at value-level.
toServant :: forall {k} routes (mode :: k). GenericServant routes mode => routes mode -> ToServant routes mode

-- | A Stream endpoint for a given method emits a stream of encoded values
--   at a given Content-Type, delimited by a framing
--   strategy. Type synonyms are provided for standard methods.
data Stream (method :: k1) (status :: Nat) framing contentType a

-- | The FramingRender class provides the logic for emitting a
--   framing strategy. The strategy transforms a SourceT m
--   a into SourceT m ByteString, therefore it
--   can prepend, append and intercalate framing structure around
--   chunks.
--   
--   Note: as the Monad m is generic, this is pure
--   transformation.
class FramingRender (strategy :: k)
framingRender :: forall (m :: Type -> Type) a. (FramingRender strategy, Monad m) => Proxy strategy -> (a -> ByteString) -> SourceT m a -> SourceT m ByteString

-- | The FramingUnrender class provides the logic for parsing a
--   framing strategy.
class FramingUnrender (strategy :: k)
framingUnrender :: forall (m :: Type -> Type) a. (FramingUnrender strategy, Monad m) => Proxy strategy -> (ByteString -> Either String a) -> SourceT m ByteString -> SourceT m a

-- | FromSourceIO is intended to be implemented for types such as
--   Conduit, Pipe, etc. By implementing this class, all such streaming
--   abstractions can be used directly on the client side for talking to
--   streaming endpoints.
class FromSourceIO chunk a | a -> chunk
fromSourceIO :: FromSourceIO chunk a => SourceIO chunk -> IO a

-- | The netstring framing strategy as defined by djb:
--   http://cr.yp.to/proto/netstrings.txt
--   
--   Any string of 8-bit bytes may be encoded as
--   [len]":"[string]",". Here [string] is the string and
--   [len] is a nonempty sequence of ASCII digits giving the
--   length of [string] in decimal. The ASCII digits are
--   30 for 0, 31 for 1, and so on up
--   through 39 for 9. Extra zeros at the front of
--   [len] are prohibited: [len] begins with
--   30 exactly when [string] is empty.
--   
--   For example, the string "hello world!" is encoded as
--   32 3a 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 2c, i.e.,
--   "12:hello world!,". The empty string is encoded as
--   "0:,".
data NetstringFraming

-- | A simple framing strategy that has no header, and inserts a newline
--   character after each frame. This assumes that it is used with a
--   Content-Type that encodes without newlines (e.g. JSON).
data NewlineFraming

-- | A framing strategy that does not do any framing at all, it just passes
--   the input data This will be used most of the time with binary data,
--   such as files
data NoFraming

-- | Stream endpoints may be implemented as producing a SourceIO
--   chunk.
--   
--   Clients reading from streaming endpoints can be implemented as
--   consuming a SourceIO chunk.
type SourceIO = SourceT IO

-- | A stream request body.
type StreamBody = StreamBody' '[] :: [Type]
data StreamBody' (mods :: [Type]) framing contentType a
type StreamGet = Stream 'GET 200
type StreamPost = Stream 'POST 200

-- | ToSourceIO is intended to be implemented for types such as
--   Conduit, Pipe, etc. By implementing this class, all such streaming
--   abstractions can be used directly as endpoints.
class ToSourceIO chunk a | a -> chunk
toSourceIO :: ToSourceIO chunk a => a -> SourceIO chunk

-- | Add more verbose description for (part of) API.
--   
--   Example:
--   
--   
--   >>> :{
--   type MyApi = Description
--    "This comment is visible in multiple Servant interpretations \
--    \and can be really long if necessary. \
--    \Haskell multiline String support is not perfect \
--    \but it's still very readable."
--   :> Get '[JSON] Book
--   :}
--   
data Description (sym :: Symbol)

-- | Add a short summary for (part of) API.
--   
--   Example:
--   
--   
--   >>> type MyApi = Summary "Get book by ISBN." :> "books" :> Capture "isbn" Text :> Get '[JSON] Book
--   
data Summary (sym :: Symbol)

-- | Instances of Accept represent mimetypes. They are used for
--   matching against the Accept HTTP header of the request, and
--   for setting the Content-Type header of the response
--   
--   Example:
--   
--   
--   >>> import Network.HTTP.Media ((//), (/:))
--   
--   >>> data HTML
--   
--   >>> :{
--   instance Accept HTML where
--      contentType _ = "text" // "html" /: ("charset", "utf-8")
--   :}
--   
class Accept (ctype :: k)
contentType :: Accept ctype => Proxy ctype -> MediaType
contentTypes :: Accept ctype => Proxy ctype -> NonEmpty MediaType
data FormUrlEncoded
data JSON

-- | Instantiate this class to register a way of serializing a type based
--   on the Accept header.
--   
--   Example:
--   
--   
--   data MyContentType
--   
--   instance Accept MyContentType where
--      contentType _ = "example" // "prs.me.mine" /: ("charset", "utf-8")
--   
--   instance Show a => MimeRender MyContentType a where
--      mimeRender _ val = pack ("This is MINE! " ++ show val)
--   
--   type MyAPI = "path" :> Get '[MyContentType] Int
--   
class Accept ctype => MimeRender (ctype :: k) a
mimeRender :: MimeRender ctype a => Proxy ctype -> a -> ByteString

-- | Instantiate this class to register a way of deserializing a type based
--   on the request's Content-Type header.
--   
--   
--   >>> import Network.HTTP.Media hiding (Accept)
--   
--   >>> import qualified Data.ByteString.Lazy.Char8 as BSC
--   
--   >>> data MyContentType = MyContentType String
--   
--   
--   
--   >>> :{
--   instance Accept MyContentType where
--      contentType _ = "example" // "prs.me.mine" /: ("charset", "utf-8")
--   :}
--   
--   
--   
--   >>> :{
--   instance Read a => MimeUnrender MyContentType a where
--      mimeUnrender _ bs = case BSC.take 12 bs of
--        "MyContentType" -> return . read . BSC.unpack $ BSC.drop 12 bs
--        _ -> Left "didn't start with the magic incantation"
--   :}
--   
--   
--   
--   >>> type MyAPI = "path" :> ReqBody '[MyContentType] Int :> Get '[JSON] Int
--   
class Accept ctype => MimeUnrender (ctype :: k) a
mimeUnrender :: MimeUnrender ctype a => Proxy ctype -> ByteString -> Either String a

-- | Variant which is given the actual MediaType provided by the
--   other party.
--   
--   In the most cases you don't want to branch based on the
--   MediaType. See pr552 for a motivating example.
mimeUnrenderWithType :: MimeUnrender ctype a => Proxy ctype -> MediaType -> ByteString -> Either String a

-- | A type for responses without content-body.
data NoContent
NoContent :: NoContent
data OctetStream
data PlainText
data ResponseHeader (sym :: Symbol) a
Header :: a -> ResponseHeader (sym :: Symbol) a
MissingHeader :: ResponseHeader (sym :: Symbol) a
UndecodableHeader :: ByteString -> ResponseHeader (sym :: Symbol) a
class AddHeader (mods :: [Type]) (h :: Symbol) v orig new | mods h v orig -> new, new -> mods, new -> h, new -> v, new -> orig
class BuildHeadersTo (hs :: [Type])
buildHeadersTo :: BuildHeadersTo hs => [Header] -> HList hs
class GetHeaders ls
getHeaders :: GetHeaders ls => ls -> [Header]
data HList (a :: [Type])
[HNil] :: HList ('[] :: [Type])
[HCons] :: forall (h :: Symbol) x (xs :: [Type]) (mods :: [Type]). ResponseHeader h x -> HList xs -> HList (Header' mods h x ': xs)
class HasResponseHeader (h :: Symbol) a (headers :: [Type])

-- | Response Header objects. You should never need to construct one
--   directly. Instead, use addOptionalHeader.
data Headers (ls :: [Type]) a
Headers :: a -> HList ls -> Headers (ls :: [Type]) a

-- | The underlying value of a Headers
[getResponse] :: Headers (ls :: [Type]) a -> a

-- | HList of headers.
[getHeadersHList] :: Headers (ls :: [Type]) a -> HList ls

-- | addHeader adds a header to a response. Note that it changes
--   the type of the value in the following ways:
--   
--   
--   
- A simple value is wrapped in "Headers '[hdr]":
--   
--   
--   
--   >>> let example0 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String;
--   
--   >>> getHeaders example0
--   [("someheader","5")]
--   
--   
--   
--   
- A value that already has a header has its new header *prepended*
--   to the existing list:
--   
--   
--   
--   >>> let example1 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String;
--   
--   >>> let example2 = addHeader True example1 :: Headers '[Header "1st" Bool, Header "someheader" Int] String
--   
--   >>> getHeaders example2
--   [("1st","true"),("someheader","5")]
--   
--   
--   Note that while in your handlers type annotations are not required,
--   since the type can be inferred from the API type, in other cases you
--   may find yourself needing to add annotations.
addHeader :: forall (h :: Symbol) v orig new. AddHeader '[Optional, Strict] h v orig new => v -> orig -> new

-- | Same as addHeader but works with Header', so it's
--   possible to use any mods.
addHeader' :: forall (mods :: [Type]) (h :: Symbol) v orig new. AddHeader mods h v orig new => v -> orig -> new

-- | Look up a specific ResponseHeader, without having to know what
--   position it is in the HList.
--   
--   
--   >>> let example1 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String
--   
--   >>> let example2 = addHeader True example1 :: Headers '[Header "1st" Bool, Header "someheader" Int] String
--   
--   >>> lookupResponseHeader example2 :: ResponseHeader "someheader" Int
--   Header 5
--   
--   
--   
--   >>> lookupResponseHeader example2 :: ResponseHeader "1st" Bool
--   Header True
--   
--   
--   Usage of this function relies on an explicit type annotation of the
--   header to be looked up. This can be done with type annotations on the
--   result, or with an explicit type application. In this example, the
--   type of header value is determined by the type-inference, we only
--   specify the name of the header:
--   
--   
--   >>> :set -XTypeApplications
--   
--   >>> case lookupResponseHeader @"1st" example2 of { Header b -> b ; _ -> False }
--   True
--   
lookupResponseHeader :: forall (h :: Symbol) a (headers :: [Type]) r. HasResponseHeader h a headers => Headers headers r -> ResponseHeader h a

-- | Deliberately do not add a header to a value.
--   
--   
--   >>> let example1 = noHeader "hi" :: Headers '[Header "someheader" Int] String
--   
--   >>> getHeaders example1
--   []
--   
noHeader :: forall (h :: Symbol) v orig new. AddHeader '[Optional, Strict] h v orig new => orig -> new

-- | Same as noHeader but works with Header', so it's
--   possible to use any mods.
noHeader' :: forall (mods :: [Type]) (h :: Symbol) v orig new. AddHeader mods h v orig new => orig -> new

-- | Parse value from HTTP API data.
--   
--   WARNING: Do not derive this using DeriveAnyClass as
--   the generated instance will loop indefinitely.
class FromHttpApiData a

-- | Parse URL path piece.
parseUrlPiece :: FromHttpApiData a => Text -> Either Text a

-- | Parse HTTP header value.
parseHeader :: FromHttpApiData a => ByteString -> Either Text a

-- | Parse query param value.
parseQueryParam :: FromHttpApiData a => Text -> Either Text a

-- | Convert value to HTTP API data.
--   
--   WARNING: Do not derive this using DeriveAnyClass as
--   the generated instance will loop indefinitely.
class ToHttpApiData a

-- | Convert to URL path piece.
toUrlPiece :: ToHttpApiData a => a -> Text

-- | Convert to a URL path piece, making sure to encode any special chars.
--   The default definition uses urlEncodeBuilder
--   False but this may be overriden with a more efficient
--   version.
toEncodedUrlPiece :: ToHttpApiData a => a -> Builder

-- | Convert to HTTP header value.
toHeader :: ToHttpApiData a => a -> ByteString

-- | Convert to query param value.
toQueryParam :: ToHttpApiData a => a -> Text

-- | Convert to URL query param, The default definition uses
--   urlEncodeBuilder True but this may be overriden
--   with a more efficient version.
toEncodedQueryParam :: ToHttpApiData a => a -> Builder

-- | Represents a general universal resource identifier using its component
--   parts.
--   
--   For example, for the URI
--   
--   
--   foo://anonymous@www.haskell.org:42/ghc?query#frag
--   
--   
--   the components are:
data URI
URI :: String -> Maybe URIAuth -> String -> String -> String -> URI

-- | 
--   foo:
--   
[uriScheme] :: URI -> String

-- | 
--   //anonymous@www.haskell.org:42
--   
[uriAuthority] :: URI -> Maybe URIAuth

-- | 
--   /ghc
--   
[uriPath] :: URI -> String

-- | 
--   ?query
--   
[uriQuery] :: URI -> String

-- | 
--   #frag
--   
[uriFragment] :: URI -> String

-- | Construct a toLink for an endpoint.
class HasLink (endpoint :: k) where {
    type MkLink (endpoint :: k) a;
}
toLink :: HasLink endpoint => (Link -> a) -> Proxy endpoint -> Link -> MkLink endpoint a

-- | Closed type family, check if endpoint is within api.
--   Uses IsElem' if it exhausts all other options.
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem ("hello" :> Get '[JSON] Int) SampleAPI))
--   OK
--   
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem ("bye" :> Get '[JSON] Int) SampleAPI))
--   ...
--   ... Could not ...
--   ...
--   
--   
--   An endpoint is considered within an api even if it is missing
--   combinators that don't affect the URL:
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem (Get '[JSON] Int) (Header "h" Bool :> Get '[JSON] Int)))
--   OK
--   
--   
--   
--   >>> ok (Proxy :: Proxy (IsElem (Get '[JSON] Int) (ReqBody '[JSON] Bool :> Get '[JSON] Int)))
--   OK
--   
--   
--   
--   
- N.B.:* IsElem a b can be seen as capturing the notion of
--   whether the URL represented by a would match the URL
--   represented by b, *not* whether a request represented by
--   a matches the endpoints serving b (for the latter,
--   use IsIn).
--   
type family IsElem endpoint api

-- | You may use this type family to tell the type checker that your custom
--   type may be skipped as part of a link. This is useful for things like
--   QueryParam that are optional in a URI and do not
--   affect them if they are omitted.
--   
--   
--   >>> data CustomThing
--   
--   >>> type instance IsElem' e (CustomThing :> s) = IsElem e s
--   
--   
--   Note that IsElem is called, which will mutually
--   recurse back to IsElem' if it exhausts all other
--   options again.
--   
--   Once you have written a HasLink instance for
--   CustomThing you are ready to go.
type family IsElem' a s

-- | A safe link datatype. The only way of constructing a Link is
--   using safeLink, which means any Link is guaranteed to be
--   part of the mentioned API.
--   
--   NOTE: If you are writing a custom HasLink instance, and need to
--   manipulate the Link (adding query params or fragments,
--   perhaps), please use the the addQueryParam and
--   addSegment functions.
data Link

-- | Create a valid (by construction) relative URI with query params.
--   
--   This function will only typecheck if endpoint is part of the
--   API api
safeLink :: (IsElem endpoint api, HasLink endpoint) => Proxy api -> Proxy endpoint -> MkLink endpoint Link
type family MkLink (endpoint :: k) a

-- | Type-level If. If True a b ==> a; If
--   False a b ==> b
type family If (cond :: Bool) (tru :: k) (fls :: k) :: k
data SBool (b :: Bool)
[STrue] :: SBool 'True
[SFalse] :: SBool 'False
class SBoolI (b :: Bool)
sbool :: SBoolI b => SBool b

-- | This is a module containing an API with all API combinators. It
--   is used for testing only (in particular, checking that instances exist
--   for the core servant classes for each combinator).
module Servant.Test.ComprehensiveAPI
type GET = Get '[JSON] NoContent
type ComprehensiveAPI = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint :<|> StreamingEndpoint :<|> RawEndpoint
type RawEndpoint = "raw" :> Raw
type StreamingEndpoint = "streaming" :> StreamBody' '[Description "netstring"] NetstringFraming JSON SourceT IO Int :> Stream 'GET 200 NetstringFraming JSON SourceT IO Int
type EmptyEndpoint = "empty-api" :> EmptyAPI
comprehensiveAPI :: Proxy ComprehensiveAPI
type ComprehensiveAPIWithoutRaw = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint :<|> StreamingEndpoint
comprehensiveAPIWithoutRaw :: Proxy ComprehensiveAPIWithoutRaw
type ComprehensiveAPIWithoutStreaming = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint :<|> RawEndpoint
comprehensiveAPIWithoutStreaming :: Proxy ComprehensiveAPIWithoutStreaming

-- | :: API -> API, so we have linear structure of the API.
type ComprehensiveAPIWithoutStreamingOrRaw' endpoint = GET :<|> "get-int" :> Get '[JSON] Int :<|> "capture" :> Capture' '[Description "example description"] "bar" Int :> GET :<|> "capture-lenient" :> Capture' '[Lenient] "foo" Int :> GET :<|> "header" :> Header "foo" Int :> GET :<|> "header-lenient" :> Header' '[Required, Lenient] "bar" Int :> GET :<|> "http-version" :> HttpVersion :> GET :<|> "is-secure" :> IsSecure :> GET :<|> "param" :> QueryParam "foo" Int :> GET :<|> "param-lenient" :> QueryParam' '[Required, Lenient] "bar" Int :> GET :<|> "params" :> QueryParams "foo" Int :> GET :<|> "flag" :> QueryFlag "foo" :> GET :<|> "remote-host" :> RemoteHost :> GET :<|> "req-body" :> ReqBody '[JSON] Int :> GET :<|> "req-body-lenient" :> ReqBody' '[Lenient] '[JSON] Int :> GET :<|> "res-headers" :> Get '[JSON] Headers '[Header "foo" Int] NoContent :<|> "foo" :> GET :<|> "vault" :> Vault :> GET :<|> "post-no-content" :> PostNoContent :<|> "post-int" :> Verb 'POST 204 '[JSON] Int :<|> "named-context" :> WithNamedContext "foo" '[] :: [Type] GET :<|> "capture-all" :> CaptureAll "foo" Int :> GET :<|> "summary" :> Summary "foo" :> GET :<|> "description" :> Description "foo" :> GET :<|> "alternative" :> "left" :> GET :<|> "right" :> GET :<|> "fragment" :> Fragment Int :> GET :<|> "resource" :> WithResource Int :> GET :<|> endpoint
type ComprehensiveAPIWithoutStreamingOrRaw = ComprehensiveAPIWithoutStreamingOrRaw' EmptyEndpoint
comprehensiveAPIWithoutStreamingOrRaw :: Proxy ComprehensiveAPIWithoutStreamingOrRaw

module Servant.API.Range

-- | A newtype wrapper around Natural that ensures the value is
--   within a given range.
--   
--   Example:
--   
--   
--   >>> :{
--     let validRange = mkRange 5 :: Maybe (Range 1 10)
--     in case validRange of
--          Just r  -> "Valid range: " ++ show (unRange r)
--          Nothing -> "Invalid range"
--   :}
--   "Valid range: 5"
--   
--   
--   
--   >>> :{
--     let invalidRange = mkRange 15 :: Maybe (Range 1 10)
--     in case invalidRange of
--          Just r  -> "Valid range: " ++ show (unRange r)
--          Nothing -> "Invalid range"
--   :}
--   "Invalid range"
--   
--   
--   
--   >>> decode "5" :: Maybe (Range 1 10)
--   Just (MkRange {unRange = 5})
--   
--   
--   
--   >>> decode "15" :: Maybe (Range 1 10)
--   Nothing
--   
data Range (min :: Nat) (max :: Nat)
unsafeRange :: forall (min :: Nat) (max :: Nat). Natural -> Range min max
mkRange :: forall (min :: Nat) (max :: Nat). (KnownNat min, KnownNat max) => Natural -> Maybe (Range min max)
instance (GHC.Internal.TypeNats.KnownNat min, GHC.Internal.TypeNats.KnownNat max) => GHC.Internal.Enum.Bounded (Servant.API.Range.Range min max)
instance GHC.Classes.Eq (Servant.API.Range.Range min max)
instance (GHC.Internal.TypeNats.KnownNat min, GHC.Internal.TypeNats.KnownNat max) => Web.Internal.HttpApiData.FromHttpApiData (Servant.API.Range.Range min max)
instance (GHC.Internal.TypeNats.KnownNat min, GHC.Internal.TypeNats.KnownNat max) => Data.Aeson.Types.FromJSON.FromJSON (Servant.API.Range.Range min max)
instance GHC.Internal.Generics.Generic (Servant.API.Range.Range min max)
instance GHC.Internal.Ix.Ix (Servant.API.Range.Range min max)
instance GHC.Classes.Ord (Servant.API.Range.Range min max)
instance GHC.Internal.Show.Show (Servant.API.Range.Range min max)
instance Web.Internal.HttpApiData.ToHttpApiData (Servant.API.Range.Range min max)
instance Data.Aeson.Types.ToJSON.ToJSON (Servant.API.Range.Range min max)
