guardian v0.5.0 → Overview → Guardian → Serializer

Guardian.Serializer behaviour

Callbacks

Guardian Serializer Behaviour.

Guardian requires a serializer. This serializer is responsible for fetching the resource from the encoded value in the JWT and also encoding a resource into a String so that it may be stored in the JWT

Callbacks

for_token/1

(callback) # ↑

Specs:

for_token(object :: term) :: String.t

Serializes the object into the token. Suggestion: “User:2”

from_token/1

(callback) # ↑

Specs:

from_token(subject :: String.t) :: {:ok, object :: term} | {:error, String.t}

De-serializes the object from a token