template

Documentation

Index

• type InvalidTemplateError
  • func Substitute(template string, mapping Mapping) (result string, err *InvalidTemplateError)
  • func (e InvalidTemplateError) Error() string
• type Mapping

Types

type InvalidTemplateError

type InvalidTemplateError struct {
	Template string
}

InvalidTemplateError is returned when a variable template is not in a valid format

func Substitute

func Substitute(template string, mapping Mapping) (result string, err *InvalidTemplateError)

Substitute variables in the string with their values

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.