template

Documentation

Overview

Package template renders the static files under the "/templates/" directory.

Index

• type Content
  • func (c *Content) MarshalBinary() ([]byte, error)
• type ParseOption
  • func WithFuncs(fns map[string]interface{}) ParseOption
• type Parser
• type ReadParser
• type Template
  • func New() *Template
  • func (t *Template) Parse(path string, data interface{}, options ...ParseOption) (*Content, error)
  • func (t *Template) Read(path string) (*Content, error)

Types

type Content

type Content struct {
	*bytes.Buffer
}

Content represents the parsed template.

func (*Content) MarshalBinary

func (c *Content) MarshalBinary() ([]byte, error)

MarshalBinary returns the contents as binary and implements the encoding.BinaryMarshaler interface.

type ParseOption

type ParseOption func(t *template.Template) *template.Template

ParseOption represents a functional option for the Parse method.

func WithFuncs

func WithFuncs(fns map[string]interface{}) ParseOption

WithFuncs returns a template that can parse additional custom functions.

type Parser

type Parser interface {
	Parse(path string, data interface{}, options ...ParseOption) (*Content, error)
}

Parser is the interface that wraps the Parse method.

type ReadParser

type ReadParser interface {
	Read(path string) (*Content, error)
	Parser
}

ReadParser is the interface that wraps the Read and Parse methods.

type Template

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

Template represents the "/templates/" directory that holds static files to be embedded in the binary.

func New

func New() *Template

New returns a Template object that can be used to parse files under the "/templates/" directory.

func (*Template) Parse

func (t *Template) Parse(path string, data interface{}, options ...ParseOption) (*Content, error)

Parse parses the template under "/templates/{path}" with the specified data object and returns its content.

func (*Template) Read

func (t *Template) Read(path string) (*Content, error)

Read returns the contents of the template under "/templates/{path}".