wire-subsystems-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.UserKeyStore

Synopsis

Documentation

data EmailKey Source #

An EmailKey is an Email in a form that serves as a unique lookup key.

Constructors

EmailKey 

Fields

Instances

Instances details
Arbitrary EmailKey Source # 
Instance details

Defined in Wire.UserKeyStore

Methods

arbitrary :: Gen EmailKey Source #

shrink :: EmailKey -> [EmailKey] Source #

Show EmailKey Source # 
Instance details

Defined in Wire.UserKeyStore

Methods

showsPrec :: Int -> EmailKey -> ShowS #

show :: EmailKey -> String #

showList :: [EmailKey] -> ShowS #

Eq EmailKey Source # 
Instance details

Defined in Wire.UserKeyStore

Methods

(==) :: EmailKey -> EmailKey -> Bool #

(/=) :: EmailKey -> EmailKey -> Bool #

Ord EmailKey Source # 
Instance details

Defined in Wire.UserKeyStore

Methods

compare :: EmailKey -> EmailKey -> Ordering #

(<) :: EmailKey -> EmailKey -> Bool #

(<=) :: EmailKey -> EmailKey -> Bool #

(>) :: EmailKey -> EmailKey -> Bool #

(>=) :: EmailKey -> EmailKey -> Bool #

max :: EmailKey -> EmailKey -> EmailKey #

min :: EmailKey -> EmailKey -> EmailKey #

mkEmailKey :: EmailAddress -> EmailKey Source #

Turn an Email into an EmailKey.

The following transformations are performed:

  • Both local and domain parts are forced to lowercase to make e-mail addresses fully case-insensitive.
  • "+" suffixes on the local part are stripped unless the domain part is contained in a trusted whitelist.

data UserKeyStore m a where Source #

Constructors

LookupKey :: EmailKey -> UserKeyStore m (Maybe UserId) 
InsertKey :: UserId -> EmailKey -> UserKeyStore m () 
DeleteKey :: EmailKey -> UserKeyStore m () 
DeleteKeyForUser :: UserId -> EmailKey -> UserKeyStore m () 
KeyAvailable :: EmailKey -> Maybe UserId -> UserKeyStore m Bool 
ClaimKey :: EmailKey -> UserId -> UserKeyStore m Bool 

claimKey :: forall r. Member UserKeyStore r => EmailKey -> UserId -> Sem r Bool Source #

keyAvailable :: forall r. Member UserKeyStore r => EmailKey -> Maybe UserId -> Sem r Bool Source #

deleteKeyForUser :: forall r. Member UserKeyStore r => UserId -> EmailKey -> Sem r () Source #

deleteKey :: forall r. Member UserKeyStore r => EmailKey -> Sem r () Source #

insertKey :: forall r. Member UserKeyStore r => UserId -> EmailKey -> Sem r () Source #

lookupKey :: forall r. Member UserKeyStore r => EmailKey -> Sem r (Maybe UserId) Source #