package tpl

import "github.com/gohugoio/hugo/tpl"

Index ¶

• type Template
• type TemplateAdapter
• func (t *TemplateAdapter) Execute(w io.Writer, data interface{}) error
• func (t *TemplateAdapter) ExecuteToString(data interface{}) (string, error)
• func (t *TemplateAdapter) Tree() string
• type TemplateDebugger
• type TemplateExecutor
• type TemplateFinder
• type TemplateFuncsGetter
• type TemplateHandler
• type TemplateParseFinder
• type TemplateParser
• type TemplateTestMocker

Types ¶

type Template ¶

type Template interface {
	Execute(wr io.Writer, data interface{}) error
	Name() string
}

Template is the common interface between text/template and html/template.

type TemplateAdapter ¶

type TemplateAdapter struct {
	Template
	Metrics metrics.Provider
}

TemplateAdapter implements the TemplateExecutor interface.

func (*TemplateAdapter) Execute ¶

func (t *TemplateAdapter) Execute(w io.Writer, data interface{}) error

Execute executes the current template. The actual execution is performed by the embedded text or html template, but we add an implementation here so we can add a timer for some metrics.

func (*TemplateAdapter) ExecuteToString ¶

func (t *TemplateAdapter) ExecuteToString(data interface{}) (string, error)

ExecuteToString executes the current template and returns the result as a string.

func (*TemplateAdapter) Tree ¶

func (t *TemplateAdapter) Tree() string

Tree returns the template Parse tree as a string. Note: this isn't safe for parallel execution on the same template vs Lookup and Execute.

type TemplateDebugger ¶

type TemplateDebugger interface {
	Debug()
}

TemplateDebugger prints some debug info to stdoud.

type TemplateExecutor ¶

type TemplateExecutor interface {
	Template
	ExecuteToString(data interface{}) (string, error)
	Tree() string
}

TemplateExecutor adds some extras to Template.

type TemplateFinder ¶

type TemplateFinder interface {
	Lookup(name string) (Template, bool)
}

TemplateFinder finds templates.

type TemplateFuncsGetter ¶

type TemplateFuncsGetter interface {
	GetFuncs() map[string]interface{}
}

TemplateFuncsGetter allows to get a map of functions.

type TemplateHandler ¶

type TemplateHandler interface {
	TemplateFinder
	AddTemplate(name, tpl string) error
	AddLateTemplate(name, tpl string) error
	LoadTemplates(prefix string)
	PrintErrors()

	NewTextTemplate() TemplateParseFinder

	MarkReady()
	RebuildClone()
}

TemplateHandler manages the collection of templates.

type TemplateParseFinder ¶

type TemplateParseFinder interface {
	TemplateParser
	TemplateFinder
}

TemplateParseFinder provides both parsing and finding.

type TemplateParser ¶

type TemplateParser interface {
	Parse(name, tpl string) (Template, error)
}

TemplateParser is used to parse ad-hoc templates, e.g. in the Resource chain.

type TemplateTestMocker ¶

type TemplateTestMocker interface {
	SetFuncs(funcMap map[string]interface{})
}

TemplateTestMocker adds a way to override some template funcs during tests. The interface is named so it's not used in regular application code.

Source Files ¶

template.go

Directories ¶