servant-server-0.19.2: A family of combinators for defining webservices APIs and serving them
Safe Haskell None
Language Haskell2010

Servant.Server.Internal

Synopsis

Documentation

class GServer (api :: * -> *) (m :: * -> *) where Source #

This class is a necessary evil: in the implementation of HasServer for NamedRoutes api , we essentially need the quantified constraint forall m. GServerConstraints m to hold.

We cannot require do that directly as the definition of GServerConstraints contains type family applications ( Rep and ServerT ). The trick is to hide those type family applications behind a typeclass providing evidence for GServerConstraints api m in the form of a dictionary, and require that forall m. GServer api m instead.

Users shouldn't have to worry about this class, as the only possible instance is provided in this module for all record APIs.

Methods

gServerProof :: Dict ( GServerConstraints api m) Source #

Instances

Instances details
( ToServant api ( AsServerT m) ~ ServerT ( ToServantApi api) m, GServantProduct ( Rep (api ( AsServerT m)))) => GServer api m Source #
Instance details

Defined in Servant.Server.Internal

Methods

gServerProof :: Dict ( GServerConstraints api m) Source #

type GServerConstraints api m = ( ToServant api ( AsServerT m) ~ ServerT ( ToServantApi api) m, GServantProduct ( Rep (api ( AsServerT m)))) Source #

Set of constraints required to convert to / from vanilla server types.

type AsServer = AsServerT Handler Source #

data AsServerT (m :: * -> *) Source #

A type that specifies that an API record contains a server implementation.

Instances

Instances details
GenericMode ( AsServerT m) Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ( AsServerT m) :- api Source #

type ( AsServerT m) :- api Source #
Instance details

Defined in Servant.Server.Internal

type ( AsServerT m) :- api = ServerT api m

type HasServerArrowTypeError a b = (((' Text "No instance HasServer (a -> b)." :$$: ' Text "Maybe you have used '->' instead of ':>' between ") :$$: ' ShowType a) :$$: ' Text "and") :$$: ' ShowType b Source #

data EmptyServer Source #

Singleton type representing a server that serves an empty API.

Constructors

EmptyServer

Instances

Instances details
Bounded EmptyServer Source #
Instance details

Defined in Servant.Server.Internal

Methods

minBound :: EmptyServer Source #

maxBound :: EmptyServer Source #

Enum EmptyServer Source #
Instance details

Defined in Servant.Server.Internal

Methods

succ :: EmptyServer -> EmptyServer Source #

pred :: EmptyServer -> EmptyServer Source #

toEnum :: Int -> EmptyServer Source #

fromEnum :: EmptyServer -> Int Source #

enumFrom :: EmptyServer -> [ EmptyServer ] Source #

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

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

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

Eq EmptyServer Source #
Instance details

Defined in Servant.Server.Internal

Methods

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

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

Show EmptyServer Source #
Instance details

Defined in Servant.Server.Internal

Methods

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

show :: EmptyServer -> String Source #

showList :: [ EmptyServer ] -> ShowS Source #

type Server api = ServerT api Handler Source #

class HasServer api context where Source #

Associated Types

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

Methods

route :: Proxy api -> Context context -> Delayed env ( Server api) -> Router env Source #

hoistServerWithContext :: Proxy api -> Proxy context -> ( forall x. m x -> n x) -> ServerT api m -> ServerT api n Source #

Instances

Instances details
( TypeError ( NoInstanceFor ( HasServer api context)) :: Constraint ) => HasServer (api :: k) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT api m Source #

Methods

route :: Proxy api -> Context context -> Delayed env ( Server api) -> Router env Source #

hoistServerWithContext :: Proxy api -> Proxy context -> ( forall x. m x -> n x) -> ServerT api m -> ServerT api n Source #

HasServer Raw context Source #

Just pass the request to the underlying application and serve its response.

Example: 

type MyApi = "images" :> Raw

server :: Server MyApi
server = serveDirectory "/var/www/images"
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT Raw m Source #

Methods

route :: Proxy Raw -> Context context -> Delayed env ( Server Raw ) -> Router env Source #

hoistServerWithContext :: Proxy Raw -> Proxy context -> ( forall x. m x -> n x) -> ServerT Raw m -> ServerT Raw n Source #

HasServer EmptyAPI context Source #

The server for an EmptyAPI is emptyServer . 

type MyApi = "nothing" :> EmptyApi

server :: Server MyApi
server = emptyServer
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT EmptyAPI m Source #

Methods

route :: Proxy EmptyAPI -> Context context -> Delayed env ( Server EmptyAPI ) -> Router env Source #

hoistServerWithContext :: Proxy EmptyAPI -> Proxy context -> ( forall x. m x -> n x) -> ServerT EmptyAPI m -> ServerT EmptyAPI n Source #

( HasServer ( ToServantApi api) context, forall (m :: Type -> Type ). Generic (api ( AsServerT m)), forall (m :: Type -> Type ). GServer api m) => HasServer ( NamedRoutes api :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( NamedRoutes api) m Source #

Methods

route :: Proxy ( NamedRoutes api) -> Context context -> Delayed env ( Server ( NamedRoutes api)) -> Router env Source #

hoistServerWithContext :: Proxy ( NamedRoutes api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( NamedRoutes api) m -> ServerT ( NamedRoutes api) n Source #

( TypeError ( HasServerArrowTypeError a b) :: Constraint ) => HasServer (a -> b :: Type ) context Source #

This instance prevents from accidentally using -> instead of :> 

>>> serve (Proxy :: Proxy (Capture "foo" Int -> Get '[JSON] Int)) (error "...")
...
...No instance HasServer (a -> b).
...Maybe you have used '->' instead of ':>' between
...Capture' '[] "foo" Int
...and
...Verb 'GET 200 '[JSON] Int
...

>>> undefined :: Server (Capture "foo" Int -> Get '[JSON] Int)
...
...No instance HasServer (a -> b).
...Maybe you have used '->' instead of ':>' between
...Capture' '[] "foo" Int
...and
...Verb 'GET 200 '[JSON] Int
...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT (a -> b) m Source #

Methods

route :: Proxy (a -> b) -> Context context -> Delayed env ( Server (a -> b)) -> Router env Source #

hoistServerWithContext :: Proxy (a -> b) -> Proxy context -> ( forall x. m x -> n x) -> ServerT (a -> b) m -> ServerT (a -> b) n Source #

ReflectMethod method => HasServer ( NoContentVerb method :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( NoContentVerb method) m Source #

Methods

route :: Proxy ( NoContentVerb method) -> Context context -> Delayed env ( Server ( NoContentVerb method)) -> Router env Source #

hoistServerWithContext :: Proxy ( NoContentVerb method) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( NoContentVerb method) m -> ServerT ( NoContentVerb method) n Source #

( HasServer a context, HasServer b context) => HasServer (a :<|> b :: Type ) context Source #

A server for a :<|> b first tries to match the request against the route represented by a and if it fails tries b . You must provide a request handler for each route. 

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

server :: Server MyApi
server = listAllBooks :<|> postBook
  where listAllBooks = ...
        postBook book = ...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT (a :<|> b) m Source #

Methods

route :: Proxy (a :<|> b) -> Context context -> Delayed env ( Server (a :<|> b)) -> Router env Source #

hoistServerWithContext :: Proxy (a :<|> b) -> Proxy context -> ( forall x. m x -> n x) -> ServerT (a :<|> b) m -> ServerT (a :<|> b) n Source #

( HasContextEntry context ( NamedContext name subContext), HasServer subApi subContext) => HasServer ( WithNamedContext name subContext subApi :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( WithNamedContext name subContext subApi) m Source #

Methods

route :: Proxy ( WithNamedContext name subContext subApi) -> Context context -> Delayed env ( Server ( WithNamedContext name subContext subApi)) -> Router env Source #

hoistServerWithContext :: Proxy ( WithNamedContext name subContext subApi) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( WithNamedContext name subContext subApi) m -> ServerT ( WithNamedContext name subContext subApi) n Source #

( ReflectMethod method, AllMime contentTypes, All (IsServerResourceWithStatus contentTypes) as, Unique ( Statuses as)) => HasServer ( UVerb method contentTypes as :: Type ) context Source #
Instance details

Defined in Servant.Server.UVerb

Associated Types

type ServerT ( UVerb method contentTypes as) m Source #

Methods

route :: Proxy ( UVerb method contentTypes as) -> Context context -> Delayed env ( Server ( UVerb method contentTypes as)) -> Router env Source #

hoistServerWithContext :: Proxy ( UVerb method contentTypes as) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( UVerb method contentTypes as) m -> ServerT ( UVerb method contentTypes as) n Source #

( TypeError ( PartialApplication ( HasServer :: k -> [ Type ] -> Constraint ) arr) :: Constraint ) => HasServer (arr :> sub :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT (arr :> sub) m Source #

Methods

route :: Proxy (arr :> sub) -> Context context -> Delayed env ( Server (arr :> sub)) -> Router env Source #

hoistServerWithContext :: Proxy (arr :> sub) -> Proxy context -> ( forall x. m x -> n x) -> ServerT (arr :> sub) m -> ServerT (arr :> sub) n Source #

HasServer api context => HasServer ( HttpVersion :> api :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( HttpVersion :> api) m Source #

Methods

route :: Proxy ( HttpVersion :> api) -> Context context -> Delayed env ( Server ( HttpVersion :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( HttpVersion :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( HttpVersion :> api) m -> ServerT ( HttpVersion :> api) n Source #

( FramingUnrender framing, FromSourceIO chunk a, MimeUnrender ctype chunk, HasServer api context) => HasServer ( StreamBody' mods framing ctype a :> api :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( StreamBody' mods framing ctype a :> api) m Source #

Methods

route :: Proxy ( StreamBody' mods framing ctype a :> api) -> Context context -> Delayed env ( Server ( StreamBody' mods framing ctype a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( StreamBody' mods framing ctype a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( StreamBody' mods framing ctype a :> api) m -> ServerT ( StreamBody' mods framing ctype a :> api) n Source #

( AllCTUnrender list a, HasServer api context, SBoolI ( FoldLenient mods), HasContextEntry ( MkContextWithErrorFormatter context) ErrorFormatters ) => HasServer ( ReqBody' mods list a :> api :: Type ) context Source #

If you use ReqBody in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of the type specified by ReqBody . The Content-Type header is inspected, and the list provided is used to attempt deserialization. If the request does not have a Content-Type header, it is treated as application/octet-stream (as specified in RFC 7231 section 3.1.1.5 ). This lets servant worry about extracting it from the request and turning it into a value of the type you specify.

All it asks is for a FromJSON instance.

Example: 

type MyApi = "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book

server :: Server MyApi
server = postBook
  where postBook :: Book -> Handler Book
        postBook book = ...insert into your db...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( ReqBody' mods list a :> api) m Source #

Methods

route :: Proxy ( ReqBody' mods list a :> api) -> Context context -> Delayed env ( Server ( ReqBody' mods list a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( ReqBody' mods list a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( ReqBody' mods list a :> api) m -> ServerT ( ReqBody' mods list a :> api) n Source #

HasServer api context => HasServer ( RemoteHost :> api :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( RemoteHost :> api) m Source #

Methods

route :: Proxy ( RemoteHost :> api) -> Context context -> Delayed env ( Server ( RemoteHost :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( RemoteHost :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( RemoteHost :> api) m -> ServerT ( RemoteHost :> api) n Source #

( KnownSymbol sym, FromHttpApiData a, HasServer api context, SBoolI ( FoldRequired mods), SBoolI ( FoldLenient mods), HasContextEntry ( MkContextWithErrorFormatter context) ErrorFormatters ) => HasServer ( QueryParam' mods sym a :> api :: Type ) context Source #

If you use QueryParam "author" Text in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of type Maybe Text .

This lets servant worry about looking it up in the query string and turning it into a value of the type you specify, enclosed in Maybe , because it may not be there and servant would then hand you Nothing .

You can control how it'll be converted from Text to your type by simply providing an instance of FromHttpApiData for your type.

Example: 

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

server :: Server MyApi
server = getBooksBy
  where getBooksBy :: Maybe Text -> Handler [Book]
        getBooksBy Nothing       = ...return all books...
        getBooksBy (Just author) = ...return books by the given author...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( QueryParam' mods sym a :> api) m Source #

Methods

route :: Proxy ( QueryParam' mods sym a :> api) -> Context context -> Delayed env ( Server ( QueryParam' mods sym a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( QueryParam' mods sym a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( QueryParam' mods sym a :> api) m -> ServerT ( QueryParam' mods sym a :> api) n Source #

( KnownSymbol sym, FromHttpApiData a, HasServer api context, HasContextEntry ( MkContextWithErrorFormatter context) ErrorFormatters ) => HasServer ( QueryParams sym a :> api :: Type ) context Source #

If you use QueryParams "authors" Text in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of type [ Text ] .

This lets servant worry about looking up 0 or more values in the query string associated to authors and turning each of them into a value of the type you specify.

You can control how the individual values are converted from Text to your type by simply providing an instance of FromHttpApiData for your type.

Example: 

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

server :: Server MyApi
server = getBooksBy
  where getBooksBy :: [Text] -> Handler [Book]
        getBooksBy authors = ...return all books by these authors...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( QueryParams sym a :> api) m Source #

Methods

route :: Proxy ( QueryParams sym a :> api) -> Context context -> Delayed env ( Server ( QueryParams sym a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( QueryParams sym a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( QueryParams sym a :> api) m -> ServerT ( QueryParams sym a :> api) n Source #

( KnownSymbol sym, HasServer api context) => HasServer ( QueryFlag sym :> api :: Type ) context Source #

If you use QueryFlag "published" in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of type Bool .

Example: 

type MyApi = "books" :> QueryFlag "published" :> Get '[JSON] [Book]

server :: Server MyApi
server = getBooks
  where getBooks :: Bool -> Handler [Book]
        getBooks onlyPublished = ...return all books, or only the ones that are already published, depending on the argument...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( QueryFlag sym :> api) m Source #

Methods

route :: Proxy ( QueryFlag sym :> api) -> Context context -> Delayed env ( Server ( QueryFlag sym :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( QueryFlag sym :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( QueryFlag sym :> api) m -> ServerT ( QueryFlag sym :> api) n Source #

( KnownSymbol sym, FromHttpApiData a, HasServer api context, SBoolI ( FoldRequired mods), SBoolI ( FoldLenient mods), HasContextEntry ( MkContextWithErrorFormatter context) ErrorFormatters ) => HasServer ( Header' mods sym a :> api :: Type ) context Source #

If you use Header in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of the type specified by Header . This lets servant worry about extracting it from the request and turning it into a value of the type you specify.

All it asks is for a FromHttpApiData instance.

Example: 

newtype Referer = Referer Text
  deriving (Eq, Show, FromHttpApiData)

           -- GET /view-my-referer
type MyApi = "view-my-referer" :> Header "Referer" Referer :> Get '[JSON] Referer

server :: Server MyApi
server = viewReferer
  where viewReferer :: Referer -> Handler referer
        viewReferer referer = return referer
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Header' mods sym a :> api) m Source #

Methods

route :: Proxy ( Header' mods sym a :> api) -> Context context -> Delayed env ( Server ( Header' mods sym a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( Header' mods sym a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Header' mods sym a :> api) m -> ServerT ( Header' mods sym a :> api) n Source #

HasServer api context => HasServer ( IsSecure :> api :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( IsSecure :> api) m Source #

Methods

route :: Proxy ( IsSecure :> api) -> Context context -> Delayed env ( Server ( IsSecure :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( IsSecure :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( IsSecure :> api) m -> ServerT ( IsSecure :> api) n Source #

( AtLeastOneFragment api, FragmentUnique ( Fragment a1 :> api), HasServer api context) => HasServer ( Fragment a1 :> api :: Type ) context Source #

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

Example: 

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

server :: Server MyApi
server = getBooks
  where getBooks :: Handler [Book]
        getBooks = ...return all books...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Fragment a1 :> api) m Source #

Methods

route :: Proxy ( Fragment a1 :> api) -> Context context -> Delayed env ( Server ( Fragment a1 :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( Fragment a1 :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Fragment a1 :> api) m -> ServerT ( Fragment a1 :> api) n Source #

( HasServer api context, HasContextEntry context ( AuthHandler Request ( AuthServerData ( AuthProtect tag)))) => HasServer ( AuthProtect tag :> api :: Type ) context Source #

Known orphan instance.

Instance details

Defined in Servant.Server.Experimental.Auth

Associated Types

type ServerT ( AuthProtect tag :> api) m Source #

Methods

route :: Proxy ( AuthProtect tag :> api) -> Context context -> Delayed env ( Server ( AuthProtect tag :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( AuthProtect tag :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( AuthProtect tag :> api) m -> ServerT ( AuthProtect tag :> api) n Source #

HasServer api ctx => HasServer ( Summary desc :> api :: Type ) ctx Source #

Ignore Summary in server handlers.

Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Summary desc :> api) m Source #

Methods

route :: Proxy ( Summary desc :> api) -> Context ctx -> Delayed env ( Server ( Summary desc :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( Summary desc :> api) -> Proxy ctx -> ( forall x. m x -> n x) -> ServerT ( Summary desc :> api) m -> ServerT ( Summary desc :> api) n Source #

HasServer api ctx => HasServer ( Description desc :> api :: Type ) ctx Source #

Ignore Description in server handlers.

Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Description desc :> api) m Source #

Methods

route :: Proxy ( Description desc :> api) -> Context ctx -> Delayed env ( Server ( Description desc :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( Description desc :> api) -> Proxy ctx -> ( forall x. m x -> n x) -> ServerT ( Description desc :> api) m -> ServerT ( Description desc :> api) n Source #

( KnownSymbol capture, FromHttpApiData a, Typeable a, HasServer api context, SBoolI ( FoldLenient mods), HasContextEntry ( MkContextWithErrorFormatter context) ErrorFormatters ) => HasServer ( Capture' mods capture a :> api :: Type ) context Source #

If you use Capture in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of the type specified by the Capture . This lets servant worry about getting it from the URL and turning it into a value of the type you specify.

You can control how it'll be converted from Text to your type by simply providing an instance of FromHttpApiData for your type.

Example: 

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

server :: Server MyApi
server = getBook
  where getBook :: Text -> Handler Book
        getBook isbn = ...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Capture' mods capture a :> api) m Source #

Methods

route :: Proxy ( Capture' mods capture a :> api) -> Context context -> Delayed env ( Server ( Capture' mods capture a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( Capture' mods capture a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Capture' mods capture a :> api) m -> ServerT ( Capture' mods capture a :> api) n Source #

( KnownSymbol capture, FromHttpApiData a, Typeable a, HasServer api context, HasContextEntry ( MkContextWithErrorFormatter context) ErrorFormatters ) => HasServer ( CaptureAll capture a :> api :: Type ) context Source #

If you use CaptureAll in one of the endpoints for your API, this automatically requires your server-side handler to be a function that takes an argument of a list of the type specified by the CaptureAll . This lets servant worry about getting values from the URL and turning them into values of the type you specify.

You can control how they'll be converted from Text to your type by simply providing an instance of FromHttpApiData for your type.

Example: 

type MyApi = "src" :> CaptureAll "segments" Text :> Get '[JSON] SourceFile

server :: Server MyApi
server = getSourceFile
  where getSourceFile :: [Text] -> Handler Book
        getSourceFile pathSegments = ...
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( CaptureAll capture a :> api) m Source #

Methods

route :: Proxy ( CaptureAll capture a :> api) -> Context context -> Delayed env ( Server ( CaptureAll capture a :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( CaptureAll capture a :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( CaptureAll capture a :> api) m -> ServerT ( CaptureAll capture a :> api) n Source #

( KnownSymbol realm, HasServer api context, HasContextEntry context ( BasicAuthCheck usr)) => HasServer ( BasicAuth realm usr :> api :: Type ) context Source #

Basic Authentication

Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( BasicAuth realm usr :> api) m Source #

Methods

route :: Proxy ( BasicAuth realm usr :> api) -> Context context -> Delayed env ( Server ( BasicAuth realm usr :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( BasicAuth realm usr :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( BasicAuth realm usr :> api) m -> ServerT ( BasicAuth realm usr :> api) n Source #

HasServer api context => HasServer ( Vault :> api :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Vault :> api) m Source #

Methods

route :: Proxy ( Vault :> api) -> Context context -> Delayed env ( Server ( Vault :> api)) -> Router env Source #

hoistServerWithContext :: Proxy ( Vault :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Vault :> api) m -> ServerT ( Vault :> api) n Source #

( KnownSymbol path, HasServer api context) => HasServer (path :> api :: Type ) context Source #

Make sure the incoming request starts with "/path" , strip it and pass the rest of the request path to api .

Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT (path :> api) m Source #

Methods

route :: Proxy (path :> api) -> Context context -> Delayed env ( Server (path :> api)) -> Router env Source #

hoistServerWithContext :: Proxy (path :> api) -> Proxy context -> ( forall x. m x -> n x) -> ServerT (path :> api) m -> ServerT (path :> api) n Source #

( TypeError ( NoInstanceForSub ( HasServer :: k2 -> [ Type ] -> Constraint ) ty) :: Constraint ) => HasServer (ty :> sub :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT (ty :> sub) m Source #

Methods

route :: Proxy (ty :> sub) -> Context context -> Delayed env ( Server (ty :> sub)) -> Router env Source #

hoistServerWithContext :: Proxy (ty :> sub) -> Proxy context -> ( forall x. m x -> n x) -> ServerT (ty :> sub) m -> ServerT (ty :> sub) n Source #

( AllCTRender ctypes a, ReflectMethod method, KnownNat status, GetHeaders ( Headers h a)) => HasServer ( Verb method status ctypes ( Headers h a) :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Verb method status ctypes ( Headers h a)) m Source #

Methods

route :: Proxy ( Verb method status ctypes ( Headers h a)) -> Context context -> Delayed env ( Server ( Verb method status ctypes ( Headers h a))) -> Router env Source #

hoistServerWithContext :: Proxy ( Verb method status ctypes ( Headers h a)) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Verb method status ctypes ( Headers h a)) m -> ServerT ( Verb method status ctypes ( Headers h a)) n Source #

( AllCTRender ctypes a, ReflectMethod method, KnownNat status) => HasServer ( Verb method status ctypes a :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Verb method status ctypes a) m Source #

Methods

route :: Proxy ( Verb method status ctypes a) -> Context context -> Delayed env ( Server ( Verb method status ctypes a)) -> Router env Source #

hoistServerWithContext :: Proxy ( Verb method status ctypes a) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Verb method status ctypes a) m -> ServerT ( Verb method status ctypes a) n Source #

( MimeRender ctype chunk, ReflectMethod method, KnownNat status, FramingRender framing, ToSourceIO chunk a, GetHeaders ( Headers h a)) => HasServer ( Stream method status framing ctype ( Headers h a) :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Stream method status framing ctype ( Headers h a)) m Source #

Methods

route :: Proxy ( Stream method status framing ctype ( Headers h a)) -> Context context -> Delayed env ( Server ( Stream method status framing ctype ( Headers h a))) -> Router env Source #

hoistServerWithContext :: Proxy ( Stream method status framing ctype ( Headers h a)) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Stream method status framing ctype ( Headers h a)) m -> ServerT ( Stream method status framing ctype ( Headers h a)) n Source #

( MimeRender ctype chunk, ReflectMethod method, KnownNat status, FramingRender framing, ToSourceIO chunk a) => HasServer ( Stream method status framing ctype a :: Type ) context Source #
Instance details

Defined in Servant.Server.Internal

Associated Types

type ServerT ( Stream method status framing ctype a) m Source #

Methods

route :: Proxy ( Stream method status framing ctype a) -> Context context -> Delayed env ( Server ( Stream method status framing ctype a)) -> Router env Source #

hoistServerWithContext :: Proxy ( Stream method status framing ctype a) -> Proxy context -> ( forall x. m x -> n x) -> ServerT ( Stream method status framing ctype a) m -> ServerT ( Stream method status framing ctype a) n Source #

allowedMethodHead :: Method -> Request -> Bool Source #

allowedMethod :: Method -> Request -> Bool Source #

methodCheck :: Method -> Request -> DelayedIO () Source #

acceptCheck :: AllMime list => Proxy list -> AcceptHeader -> DelayedIO () Source #

methodRouter :: AllCTRender ctypes a => (b -> ([( HeaderName , ByteString )], a)) -> Method -> Proxy ctypes -> Status -> Delayed env ( Handler b) -> Router env Source #

noContentRouter :: Method -> Status -> Delayed env ( Handler b) -> Router env Source #

streamRouter :: forall ctype a c chunk env framing. ( MimeRender ctype chunk, FramingRender framing, ToSourceIO chunk a) => (c -> ([( HeaderName , ByteString )], a)) -> Method -> Status -> Proxy framing -> Proxy ctype -> Delayed env ( Handler c) -> Router env Source #

emptyServer :: ServerT EmptyAPI m Source #

Server for EmptyAPI

ct_wildcard :: ByteString Source #

getAcceptHeader :: Request -> AcceptHeader Source #

module Servant.Server.Internal.BasicAuth

module Servant.Server.Internal.Context

module Servant.Server.Internal.Delayed

module Servant.Server.Internal.DelayedIO

module Servant.Server.Internal.ErrorFormatter

module Servant.Server.Internal.Handler

module Servant.Server.Internal.Router

module Servant.Server.Internal.RouteResult

module Servant.Server.Internal.RoutingApplication

module Servant.Server.Internal.ServerError