fasttemplate

Documentation

Overview

Package fasttemplate implements simple and fast template library.

Fasttemplate is faster than text/template, strings.Replace and strings.Replacer.

Fasttemplate ideally fits for fast and simple placeholders' substitutions.

Index

• func Execute(template, startTag, endTag string, w io.Writer, m map[string]interface{}) (int64, error)
• func ExecuteFunc(template, startTag, endTag string, w io.Writer, f TagFunc) (int64, error)
• func ExecuteFuncString(template, startTag, endTag string, f TagFunc) string
• func ExecuteFuncStringWithErr(template, startTag, endTag string, f TagFunc) (string, error)
• func ExecuteStd(template, startTag, endTag string, w io.Writer, m map[string]interface{}) (int64, error)
• func ExecuteString(template, startTag, endTag string, m map[string]interface{}) string
• func ExecuteStringStd(template, startTag, endTag string, m map[string]interface{}) string
• type TagFunc
• type Template
  • func New(template, startTag, endTag string) *Template
  • func NewTemplate(template, startTag, endTag string) (*Template, error)
  • func (t *Template) Execute(w io.Writer, m map[string]interface{}) (int64, error)
  • func (t *Template) ExecuteFunc(w io.Writer, f TagFunc) (int64, error)
  • func (t *Template) ExecuteFuncString(f TagFunc) string
  • func (t *Template) ExecuteFuncStringWithErr(f TagFunc) (string, error)
  • func (t *Template) ExecuteStd(w io.Writer, m map[string]interface{}) (int64, error)
  • func (t *Template) ExecuteString(m map[string]interface{}) string
  • func (t *Template) ExecuteStringStd(m map[string]interface{}) string
  • func (t *Template) Reset(template, startTag, endTag string) error

Functions

func Execute

func Execute(template, startTag, endTag string, w io.Writer, m map[string]interface{}) (int64, error)

Execute substitutes template tags (placeholders) with the corresponding values from the map m and writes the result to the given writer w.

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

Returns the number of bytes written to w.

This function is optimized for constantly changing templates. Use Template.Execute for frozen templates.

func ExecuteFunc

func ExecuteFunc(template, startTag, endTag string, w io.Writer, f TagFunc) (int64, error)

ExecuteFunc calls f on each template tag (placeholder) occurrence.

Returns the number of bytes written to w.

This function is optimized for constantly changing templates. Use Template.ExecuteFunc for frozen templates.

func ExecuteFuncString

func ExecuteFuncString(template, startTag, endTag string, f TagFunc) string

ExecuteFuncString calls f on each template tag (placeholder) occurrence and substitutes it with the data written to TagFunc's w.

Returns the resulting string.

This function is optimized for constantly changing templates. Use Template.ExecuteFuncString for frozen templates.

func ExecuteFuncStringWithErr

func ExecuteFuncStringWithErr(template, startTag, endTag string, f TagFunc) (string, error)

ExecuteFuncStringWithErr is nearly the same as ExecuteFuncString but when f returns an error, ExecuteFuncStringWithErr won't panic like ExecuteFuncString it just returns an empty string and the error f returned

func ExecuteStd

func ExecuteStd(template, startTag, endTag string, w io.Writer, m map[string]interface{}) (int64, error)

ExecuteStd works the same way as Execute, but keeps the unknown placeholders. This can be used as a drop-in replacement for strings.Replacer

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

Returns the number of bytes written to w.

This function is optimized for constantly changing templates. Use Template.ExecuteStd for frozen templates.

func ExecuteString

func ExecuteString(template, startTag, endTag string, m map[string]interface{}) string

ExecuteString substitutes template tags (placeholders) with the corresponding values from the map m and returns the result.

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

This function is optimized for constantly changing templates. Use Template.ExecuteString for frozen templates.

func ExecuteStringStd

func ExecuteStringStd(template, startTag, endTag string, m map[string]interface{}) string

ExecuteStringStd works the same way as ExecuteString, but keeps the unknown placeholders. This can be used as a drop-in replacement for strings.Replacer

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

This function is optimized for constantly changing templates. Use Template.ExecuteStringStd for frozen templates.

Types

type TagFunc

type TagFunc func(w io.Writer, tag string) (int, error)

TagFunc can be used as a substitution value in the map passed to Execute*. Execute* functions pass tag (placeholder) name in 'tag' argument.

TagFunc must be safe to call from concurrently running goroutines.

TagFunc must write contents to w and return the number of bytes written.

type Template

type Template struct {
	// contains filtered or unexported fields
}

Template implements simple template engine, which can be used for fast tags' (aka placeholders) substitution.

func New

func New(template, startTag, endTag string) *Template

New parses the given template using the given startTag and endTag as tag start and tag end.

The returned template can be executed by concurrently running goroutines using Execute* methods.

New panics if the given template cannot be parsed. Use NewTemplate instead if template may contain errors.

func NewTemplate

func NewTemplate(template, startTag, endTag string) (*Template, error)

NewTemplate parses the given template using the given startTag and endTag as tag start and tag end.

The returned template can be executed by concurrently running goroutines using Execute* methods.

func (*Template) Execute

func (t *Template) Execute(w io.Writer, m map[string]interface{}) (int64, error)

Execute substitutes template tags (placeholders) with the corresponding values from the map m and writes the result to the given writer w.

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

Returns the number of bytes written to w.

func (*Template) ExecuteFunc

func (t *Template) ExecuteFunc(w io.Writer, f TagFunc) (int64, error)

ExecuteFunc calls f on each template tag (placeholder) occurrence.

Returns the number of bytes written to w.

This function is optimized for frozen templates. Use ExecuteFunc for constantly changing templates.

func (*Template) ExecuteFuncString

func (t *Template) ExecuteFuncString(f TagFunc) string

ExecuteFuncString calls f on each template tag (placeholder) occurrence and substitutes it with the data written to TagFunc's w.

Returns the resulting string.

This function is optimized for frozen templates. Use ExecuteFuncString for constantly changing templates.

func (*Template) ExecuteFuncStringWithErr

func (t *Template) ExecuteFuncStringWithErr(f TagFunc) (string, error)

ExecuteFuncStringWithErr calls f on each template tag (placeholder) occurrence and substitutes it with the data written to TagFunc's w.

Returns the resulting string.

This function is optimized for frozen templates. Use ExecuteFuncString for constantly changing templates.

func (*Template) ExecuteStd

func (t *Template) ExecuteStd(w io.Writer, m map[string]interface{}) (int64, error)

ExecuteStd works the same way as Execute, but keeps the unknown placeholders. This can be used as a drop-in replacement for strings.Replacer

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

Returns the number of bytes written to w.

func (*Template) ExecuteString

func (t *Template) ExecuteString(m map[string]interface{}) string

ExecuteString substitutes template tags (placeholders) with the corresponding values from the map m and returns the result.

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

This function is optimized for frozen templates. Use ExecuteString for constantly changing templates.

func (*Template) ExecuteStringStd

func (t *Template) ExecuteStringStd(m map[string]interface{}) string

ExecuteStringStd works the same way as ExecuteString, but keeps the unknown placeholders. This can be used as a drop-in replacement for strings.Replacer

Substitution map m may contain values with the following types:

• []byte - the fastest value type
• string - convenient value type
• TagFunc - flexible value type

This function is optimized for frozen templates. Use ExecuteStringStd for constantly changing templates.

func (*Template) Reset

func (t *Template) Reset(template, startTag, endTag string) error

Reset resets the template t to new one defined by template, startTag and endTag.

Reset allows Template object re-use.

Reset may be called only if no other goroutines call t methods at the moment.