Guardian

v1.0.0-beta.0

Guardian v1.0.0-beta.0 Guardian.Config View Source

Working with configuration for guardian.

Link to this section Summary

Types

config_value()

Configuration values can be given using the following types

Functions

resolve_value(f)

Resolves possible values from a configuration

Link to this section Types

Link to this type config_value() View Source 
config_value ::
  {:system, String.t} |
  {module, atom} |
  {module, atom, [any]} |
  (... -> any) |
  any

Configuration values can be given using the following types:

  • {:system, "FOO"} - Read from the system environment
  • {MyModule, :function_name} - To call a function and use the result
  • {MyModule, :func, [:some, :args]} Calls the function on the module with args
  • fn -> :some_value end - an anonymous function whose result will be used
  • any other value

Link to this section Functions

Link to this function resolve_value(f) View Source 
resolve_value(value :: config_value) :: any

Resolves possible values from a configuration.

  • {:system, "FOO"} - reads “FOO” from the environment
  • {m, f} - Calls function f on module m and returns the result
  • {m, f, a} - Calls function f on module m with arguments a and returns the result
  • f - Calls the function f and returns the result
  • value - Returns other values as is