stencil

Documentation

Index

• func FuncMap(funcs map[string]interface{}) (f template.FuncMap)
• func Template(opts TemplateOptions) (err kv.Error, warnings []kv.Error)
• type TemplateIOFiles
• type TemplateOptions

Functions

func FuncMap

func FuncMap(funcs map[string]interface{}) (f template.FuncMap)

FuncMap augments the template functions with some standard string manipulation functions for document format conversions

func Template

func Template(opts TemplateOptions) (err kv.Error, warnings []kv.Error)

Template takes the TemplateOptions and processes the template execution, it also it used to catch and report errors the user raises within the template from validation checking etc

Types

type TemplateIOFiles

type TemplateIOFiles struct {
	In  io.Reader
	Out io.Writer
}

TemplateIOFiles is used to encapsulate some streaming interfaces for input and output documents

type TemplateOptions

type TemplateOptions struct {
	IOFiles        []TemplateIOFiles
	Delimiters     []string
	ValueFiles     []string
	OverrideValues map[string]string
}

TemplateOptions is used to pass into the Template function both streams and key values for the template engine