Module providers

Data Types
Function Index
Function Details

Data Types

t()

t() = #provider{name = atom(), module = module(), hooks = {list(), list()}, bare = boolean(), deps = [atom()], desc = string(), short_desc = string(), example = string() | undefined, opts = list(), profiles = [atom()], namespace = atom()}

Function Index

create/1
desc/1
do/2	Run provider and hooks.
format/1	print the provider module name.
format_error/1
format_error/2	format an error produced from a provider.
get_provider/2
get_provider/3
get_provider_by_module/2
get_providers_by_namespace/2
get_target_providers/2
get_target_providers/3
help/1
help/2
help/3
hooks/1
hooks/2
impl/1
module/1	get the name of the module that implements the provider.
namespace/1
new/2	create a new provider object from the specified module.
opts/1
process_deps/2
profiles/1

Function Details

create/1

create(Attrs::list()) -> t()

desc/1

desc(Provider::t()) -> string()

do/2

do(Provider::t(), State::any()) -> {ok, any()} | {error, string()} | {error, {module(), any()}}

Provider: the provider object
State: the current state of the system

Run provider and hooks.

format/1

format(Provider::t()) -> iolist()

returns: An iolist describing the provider

print the provider module name

format_error/1

format_error(X1) -> any()

format_error/2

format_error(Provider::t(), Reason::term()) -> iolist()

format an error produced from a provider.

get_provider/2

get_provider(ProviderName::atom() | {atom(), atom()}, Providers::[t()]) -> t() | not_found

get_provider/3

get_provider(ProviderName::atom(), Rest::[t()], Namespace::atom()) -> t() | not_found

get_provider_by_module/2

get_provider_by_module(ProviderModule::atom(), Rest::[t()]) -> t() | not_found

get_providers_by_namespace/2

get_providers_by_namespace(Namespace::atom(), Rest::[t()]) -> [t()]

get_target_providers/2

get_target_providers(Target::{atom(), atom()} | atom(), Providers::list()) -> [{atom(), atom()}]

get_target_providers/3

get_target_providers(Target, Providers, Namespace) -> any()

help/1

help(Providers) -> any()

help/2

help(Name, Providers) -> any()

help/3

help(Name, Providers, Namespace) -> any()

hooks/1

hooks(Provider::t()) -> {[t()], [t()]}

hooks/2

hooks(Provider::t(), Hooks::{[t()], [t()]}) -> t()

impl/1

impl(Provider::t()) -> atom()

module/1

module(Provider::t()) -> module()

get the name of the module that implements the provider

namespace/1

namespace(Provider::t()) -> atom()

new/2

new(ModuleName::module(), State::any()) -> {ok, any()} | {error, string()}

ModuleName: The module name.

create a new provider object from the specified module. The module should implement the provider behaviour.

opts/1

opts(Provider::t()) -> list()

process_deps/2

process_deps(TargetProviders, Providers) -> any()

profiles/1

profiles(Provider::t()) -> [atom()]

Generated by EDoc