Crypto.Paseto.Token.Claims

Collection of PASETO token claims.

It is recommended to import this module qualified since it contains functions which may conflict with those in Prelude and other container implementations such as Data.Map.

For example:

import Crypto.Paseto.Token.Claims (Claims)
import qualified Crypto.Paseto.Token.Claims as Claims

Claims type

data Claims

Collection of Claims.

Instances

FromJSON Claims

Defined in Crypto.Paseto.Token.Claims

Methods

parseJSON :: Value -> Parser Claims

parseJSONList :: Value -> Parser [Claims]

omittedField :: Maybe Claims

ToJSON Claims

Defined in Crypto.Paseto.Token.Claims

Methods

toJSON :: Claims -> Value

toEncoding :: Claims -> Encoding

toJSONList :: [Claims] -> Value

toEncodingList :: [Claims] -> Encoding

omitField :: Claims -> Bool

Monoid Claims

Defined in Crypto.Paseto.Token.Claims

Methods

mempty :: Claims

mappend :: Claims -> Claims -> Claims

mconcat :: [Claims] -> Claims

Semigroup Claims

Defined in Crypto.Paseto.Token.Claims

Methods

(<>) :: Claims -> Claims -> Claims

sconcat :: NonEmpty Claims -> Claims

stimes :: Integral b => b -> Claims -> Claims

Show Claims

Defined in Crypto.Paseto.Token.Claims

Methods

showsPrec :: Int -> Claims -> ShowS

show :: Claims -> String

showList :: [Claims] -> ShowS

Eq Claims

Defined in Crypto.Paseto.Token.Claims

Methods

(==) :: Claims -> Claims -> Bool

(/=) :: Claims -> Claims -> Bool

Construction

empty :: Claims

Empty collection of claims.

singleton :: Claim -> Claims

Construct a collection of claims with a single element.

Insertion

insert :: Claim -> Claims -> Claims

Insert a Claim into a collection of Claims.

Note that if a claim with the same key is already present, it is replaced with the provided claim.

Deletion

delete :: ClaimKey -> Claims -> Claims

Delete a claim from the collection.

Query

lookupIssuer :: Claims -> Maybe Issuer

Lookup the issuer claim.

lookupSubject :: Claims -> Maybe Subject

Lookup the subject claim.

lookupAudience :: Claims -> Maybe Audience

Lookup the audience claim.

lookupExpiration :: Claims -> Maybe Expiration

Lookup the expiration claim.

lookupNotBefore :: Claims -> Maybe NotBefore

Lookup the "not before" claim.

lookupIssuedAt :: Claims -> Maybe IssuedAt

Lookup the "issued at" claim.

lookupTokenIdentifier :: Claims -> Maybe TokenIdentifier

Lookup the token identifier claim.

lookupCustom :: UnregisteredClaimKey -> Claims -> Maybe Value

Lookup a custom unregistered claim.

null :: Claims -> Bool

Whether a collection of claims is empty.

size :: Claims -> Int

Size of a collection of claims.

Conversion

toList :: Claims -> [Claim]

Convert a collection of Claims to a list of Claims.

fromList :: [Claim] -> Claims

Convert a list of Claims to a collection of Claims.

Note that if the provided list contains more than one value for the same claim, the last value for that claim is retained.