View Source Provider.Source behaviour (provider v0.2.0)

Contract for storage sources.

Summary

Callbacks

Invoked to convert the param name to storage specific name.

Invoked to create operator template.

Invoked to provide the values for the given parameters.

Callbacks

Link to this callback

display_name(param_name)

View Source
@callback display_name(Provider.param_name()) :: String.t()

Invoked to convert the param name to storage specific name.

@callback template(Provider.params()) :: String.t()

Invoked to create operator template.

@callback values([Provider.param_name()]) :: [Provider.value()]

Invoked to provide the values for the given parameters.

This function should return all values in the requested orders. For each param which is not available, nil should be returned.