Packages
guardian
0.5.0
2.4.0
2.3.2
2.3.1
2.3.0
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.2
2.1.1
2.0.0
1.2.1
1.2.0
retired
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-beta.1
1.0.0-beta.0
0.14.6
0.14.5
0.14.4
0.14.3
retired
0.14.2
0.14.1
0.14.0
0.13.0
0.12.0
0.11.1
0.10.1
0.10.0
0.9.1
0.9.0
0.8.1
0.8.0
0.7.4
0.7.2
0.7.1
0.7.0
0.6.3
0.6.2
0.6.1
0.6.0
0.5.2
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.0
0.1.1
0.1.0
Elixir Authentication framework
Current section
Files
Jump to
Current section
Files
lib/guardian/serializer.ex
defmodule Guardian.Serializer do
@moduledoc """
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
"""
use Behaviour
@doc """
Serializes the object into the token. Suggestion: \"User:2\"
"""
defcallback for_token(object :: term) :: String.t
@doc """
De-serializes the object from a token
"""
defcallback from_token(subject :: String.t) :: { :ok, object :: term } | { :error, String.t }
end