Documentation
¶
Index ¶
- func ExtractVariables(configDict map[string]interface{}, pattern *regexp.Regexp) map[string]Variable
- func Substitute(template string, mapping Mapping) (string, error)
- func SubstituteWith(template string, mapping Mapping, pattern *regexp.Regexp, ...) (string, error)
- type InvalidTemplateError
- type Mapping
- type SubstituteFunc
- type Variable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExtractVariables ¶
func ExtractVariables(configDict map[string]interface{}, pattern *regexp.Regexp) map[string]Variable
ExtractVariables returns a map of all the variables defined in the specified composefile (dict representation) and their default value if any.
func Substitute ¶
Substitute variables in the string with their values
func SubstituteWith ¶
func SubstituteWith(template string, mapping Mapping, pattern *regexp.Regexp, subsFuncs ...SubstituteFunc) (string, error)
SubstituteWith substitute variables in the string with their values. It accepts additional substitute function.
Types ¶
type InvalidTemplateError ¶
type InvalidTemplateError struct {
Template string
}
InvalidTemplateError is returned when a variable template is not in a valid format
func (InvalidTemplateError) Error ¶
func (e InvalidTemplateError) Error() string
type Mapping ¶
Mapping is a user-supplied function which maps from variable names to values. Returns the value as a string and a bool indicating whether the value is present, to distinguish between an empty string and the absence of a value.
type SubstituteFunc ¶
SubstituteFunc is a user-supplied function that apply substitution. Returns the value as a string, a bool indicating if the function could apply the substitution and an error.
Source Files