Libjwt.Encoding

JWT encoding definition

This module can be considered internal to the library Users should never need to implement the Encode typeclass or use any of the exported functions or types directly. You'll only need to know of Encode typeclass if you want to write a function polymorphic in the type of payloads.

If you want to extend the types supported by the library, see Libjwt.Classes

Documentation

type EncodeResult = JwtIO ()

class Encode c where

Definition of claims encoding.

The only use for the user is probably to write a function that is polymorphic in the payload type.

Methods

encode :: c -> JwtT -> EncodeResult

Perform the encoding as impure action

Instances

Encode Typ

Defined in Libjwt.Header

Methods

encode :: Typ -> JwtT -> EncodeResult

Encode Jti

Defined in Libjwt.RegisteredClaims

Methods

encode :: Jti -> JwtT -> EncodeResult

Encode Iat

Defined in Libjwt.RegisteredClaims

Methods

encode :: Iat -> JwtT -> EncodeResult

Encode Nbf

Defined in Libjwt.RegisteredClaims

Methods

encode :: Nbf -> JwtT -> EncodeResult

Encode Exp

Defined in Libjwt.RegisteredClaims

Methods

encode :: Exp -> JwtT -> EncodeResult

Encode Aud

Defined in Libjwt.RegisteredClaims

Methods

encode :: Aud -> JwtT -> EncodeResult

Encode Sub

Defined in Libjwt.RegisteredClaims

Methods

encode :: Sub -> JwtT -> EncodeResult

Encode Iss

Defined in Libjwt.RegisteredClaims

Methods

encode :: Iss -> JwtT -> EncodeResult

(ClaimEncoder a, KnownSymbol name, KnownNamespace ns, Encode (PrivateClaims tl ns)) => Encode (PrivateClaims ((name ->> a) ': tl) ns)

Defined in Libjwt.PrivateClaims

Methods

encode :: PrivateClaims ((name ->> a) ': tl) ns -> JwtT -> EncodeResult

Encode (PrivateClaims Empty ns)

Defined in Libjwt.PrivateClaims

Methods

encode :: PrivateClaims Empty ns -> JwtT -> EncodeResult

Encode (PrivateClaims pc ns) => Encode (Payload pc ns)

Defined in Libjwt.Payload

Methods

encode :: Payload pc ns -> JwtT -> EncodeResult

class ClaimEncoder t where

Low-level definition of JWT claims encoding.

Methods

encodeClaim :: String -> t -> JwtT -> EncodeResult

Given a pointer to jwt_t, mutate the structure it points to to encode the value as a named claim It relies on the functions exported from Libjwt.FFI.Jwt to perform an impure effect of encoding

Instances

(EncoderDef a ~ ty, ClaimEncoder' ty a) => ClaimEncoder a

Defined in Libjwt.Encoding

Methods

encodeClaim :: String -> a -> JwtT -> EncodeResult

nullEncode :: b -> EncodeResult

Do not perform any action. It is used to encode things like empty lists or Nothing