Moduleservant-auth-server-0.4.10.0Haskell2010

Servant.Auth.Server.Internal.Types

Synopsis

data AuthResult
newtype AuthCheck

Packageservant-auth-server-0.4.10.0
Exports2
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

datadata AuthResult val

Source#

The result of an authentication attempt.

Constructors

BadPassword
NoSuchUser
Authenticated val
Authentication succeeded.
Indefinite
If an authentication procedure cannot be carried out - if for example it expects a password and username in a header that is not present - Indefinite is returned. This indicates that other authentication methods should be tried.

Instances15Monad, Functor, Applicative, Foldable, Traversable, Alternative, …

Monad AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Functor AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Applicative AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Foldable AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Traversable AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Alternative AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
MonadPlus AuthResultDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Eq val => Eq (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Ord val => Ord (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Read val => Read (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Show val => Show (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Generic (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Semigroup (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Monoid (AuthResult val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
type Rep (AuthResult val) = D1 ('MetaData "AuthResult" "Servant.Auth.Server.Internal.Types" "servant-auth-server-0.4.10.0-73t7hz2ENRC2DHkv6Xfn8T" 'False) ((C1 ('MetaCons "BadPassword" 'PrefixI 'False) U1 :+: C1 ('MetaCons "NoSuchUser" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Authenticated" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 val)) :+: C1 ('MetaCons "Indefinite" 'PrefixI 'False) U1))Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types

newtypenewtype AuthCheck val

Source#

An AuthCheck is the function used to decide the authentication status (the AuthResult) of a request. Different AuthChecks may be combined as a Monoid or Alternative; the semantics of this is that the *first* non-Indefinite result from left to right is used and the rest are ignored.

Constructors

AuthCheck
- runAuthCheck :: Request -> IO (AuthResult val)

Instances13Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus, …

Monad AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Functor AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
MonadFail AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Applicative AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Alternative AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
MonadPlus AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
MonadIO AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
MonadTime AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
MonadReader Request AuthCheckDefined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Generic (AuthCheck val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Semigroup (AuthCheck val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
Monoid (AuthCheck val)Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types
type Rep (AuthCheck val) = D1 ('MetaData "AuthCheck" "Servant.Auth.Server.Internal.Types" "servant-auth-server-0.4.10.0-73t7hz2ENRC2DHkv6Xfn8T" 'True) (C1 ('MetaCons "AuthCheck" 'PrefixI 'True) (S1 ('MetaSel ('Just "runAuthCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Request -> IO (AuthResult val)))))Defined in servant-auth-server-0.4.10.0 · Servant.Auth.Server.Internal.Types