View Source Hush.Provider behaviour (hush v1.0.2)

Hush relies on providers to resolve values that the consumer requests.

You can read here on how to write your own provider.

Link to this section Summary

child_spec()

fetch(key)

load(config)

Fetch a value from a provider

valid?(provider)

Is the provider a valid one?

@type child_spec() :: Supervisor.child_spec()

@callback fetch(key :: String.t()) ::
  {:ok, String.t()} | {:error, :not_found} | {:error, any()}

@callback load(config :: Keyword.t()) :: :ok | {:ok, [child_spec()]} | {:error, any()}

@spec fetch(module(), String.t()) ::
  {:ok, String.t() | nil} | {:error, :required} | {:error, any()}

Fetch a value from a provider

@spec valid?(module()) :: :ok | {:error, String.t()}

Is the provider a valid one?