eeva/servant
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

reworded Context comment

Browse source
This commit is contained in:
Sönke Hahn 2016-03-01 09:53:49 +08:00
parent 8ef4d4543b
commit c6b6639453
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
servant-server/src/Servant/Server/Internal/Context.hs
View file

@ -15,14 +15,19 @@ module Servant.Server.Internal.Context where
import Data.Proxy import Data.Proxy
import GHC.TypeLits import GHC.TypeLits
-- | When calling 'Servant.Server.serve' you have to supply a context -- | 'Context's are used to pass values to combinators. (They are __not__ meant
-- value of type @'Context' contextTypes@. This parameter is used to pass values -- to be used to pass parameters to your handlers, i.e. they should not replace
-- to combinators. (It shouldn't be confused with general configuration -- any custom 'Control.Monad.Trans.Reader.ReaderT'-monad-stack that you're using
-- parameters for your web app, like the port, etc.). If you don't use -- with 'Servant.Server.Internal.Enter.enter'.) If you don't use combinators that
-- combinators that require any context entries, you can just use `serve` (or -- require any context entries, you can just use 'Servant.Server.serve' as always.
-- pass 'EmptyContext'). To create a context with entries, use the operator --
-- @(':.')@. The parameter of the type 'Context' is a type-level list reflecting -- If you are using combinators that require a non-empty 'Context' you have to
-- the types of the contained context entries: -- use 'Servant.Server.serveWithContext' and pass it a 'Context' that contains all
-- the values your combinators need. A 'Context' is essentially a heterogenous
-- list and accessing the elements is being done by type (see 'getContextEntry').
-- The parameter of the type 'Context' is a type-level list reflecting the types
-- of the contained context entries. To create a 'Context' with entries, use the
-- operator @(':.')@:
-- --
-- >>> :type True :. () :. EmptyContext -- >>> :type True :. () :. EmptyContext
-- True :. () :. EmptyContext :: Context '[Bool, ()] -- True :. () :. EmptyContext :: Context '[Bool, ()]