template

Documentation

Index

• Variables
• func ExtractVariables(configDict map[string]any, pattern *regexp.Regexp) map[string]string
• func Substitute(template string, mapping Mapping) (string, error)
• func SubstituteWith(template string, mapping Mapping, pattern *regexp.Regexp, ...) (string, error)
• type InvalidTemplateError
  • func (e InvalidTemplateError) Error() string
• type Mapping
• type SubstituteFunc

Variables

var DefaultSubstituteFuncs = []SubstituteFunc{
	softDefault,
	hardDefault,
	requiredNonEmpty,
	required,
}

DefaultSubstituteFuncs contains the default SubstituteFunc used by the docker cli

Functions

func ExtractVariables

func ExtractVariables(configDict map[string]any, pattern *regexp.Regexp) map[string]string

ExtractVariables returns a map of all the variables defined in the specified composefile (dict representation) and their default value if any.

func Substitute

func Substitute(template string, mapping Mapping) (string, error)

Substitute variables in the string with their values

func SubstituteWith

func SubstituteWith(template string, mapping Mapping, pattern *regexp.Regexp, subsFuncs ...SubstituteFunc) (string, error)

SubstituteWith substitutes 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

type Mapping func(string) (string, bool)

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

type SubstituteFunc func(string, Mapping) (string, bool, error)

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.