servant-server-0.20.2: A family of combinators for defining webservices APIs and serving them
Safe HaskellSafe-Inferred
LanguageHaskell2010

Servant.Server.Experimental.Auth

Synopsis

General Auth

type family AuthServerData a :: Type Source #

Specify the type of data returned after we've authenticated a request. quite often this is some User datatype.

NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

newtype AuthHandler r usr Source #

Handlers for AuthProtected resources

NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

Constructors

AuthHandler 

Fields

Instances

Instances details
Functor (AuthHandler r) Source # 
Instance details

Defined in Servant.Server.Experimental.Auth

Methods

fmap :: (a -> b) -> AuthHandler r a -> AuthHandler r b #

(<$) :: a -> AuthHandler r b -> AuthHandler r a #

Generic (AuthHandler r usr) Source # 
Instance details

Defined in Servant.Server.Experimental.Auth

Associated Types

type Rep (AuthHandler r usr) :: Type -> Type #

Methods

from :: AuthHandler r usr -> Rep (AuthHandler r usr) x #

to :: Rep (AuthHandler r usr) x -> AuthHandler r usr #

type Rep (AuthHandler r usr) Source # 
Instance details

Defined in Servant.Server.Experimental.Auth

type Rep (AuthHandler r usr) = D1 ('MetaData "AuthHandler" "Servant.Server.Experimental.Auth" "servant-server-0.20.2-FYExcgb62hXBp47M2qEByj" 'True) (C1 ('MetaCons "AuthHandler" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAuthHandler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (r -> Handler usr))))

mkAuthHandler :: (r -> Handler usr) -> AuthHandler r usr Source #

NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE

Orphan instances

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

Known orphan instance.

Instance details

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 #