Charon.Utils (Charon v4.2.0)

Utility functions, mainly getters and setters for module internals.

Summary

Functions

get_auth_error(conn)

Get auth errors, if present.

get_bearer_token(conn)

Get the bearer token, if present.

get_bearer_token_payload(conn)

Get the payload of the bearer token, if present.

get_session(conn)

Get current session, if present.

get_token_transport(conn)

Get token transport mechanism, if present.

get_tokens(conn)

Get tokens, if present.

set_auth_error(conn, error)

Put an auth error on the conn

set_session(conn, session)

Put a session on the conn

set_token(conn, token)

Put a token on the conn

set_token_payload(conn, payload)

Put a token payload on the conn

Functions

get_auth_error(conn)

@spec get_auth_error(Plug.Conn.t()) :: binary() | nil

Get auth errors, if present.

get_bearer_token(conn)

@spec get_bearer_token(Plug.Conn.t()) :: map() | nil

Get the bearer token, if present.

get_bearer_token_payload(conn)

@spec get_bearer_token_payload(Plug.Conn.t()) :: map() | nil

Get the payload of the bearer token, if present.

get_session(conn)

@spec get_session(Plug.Conn.t()) :: Charon.Models.Session.t() | nil

Get current session, if present.

get_token_transport(conn)

(since 3.1.0)

@spec get_token_transport(Plug.Conn.t()) :: atom() | nil

Get token transport mechanism, if present.

get_tokens(conn)

@spec get_tokens(Plug.Conn.t()) :: Charon.Models.Tokens.t() | nil

Get tokens, if present.

set_auth_error(conn, error)

@spec set_auth_error(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put an auth error on the conn

set_session(conn, session)

@spec set_session(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put a session on the conn

set_token(conn, token)

@spec set_token(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put a token on the conn

set_token_payload(conn, payload)

@spec set_token_payload(Plug.Conn.t(), any()) :: Plug.Conn.t()

Put a token payload on the conn