templ

README

templ

Static typed templating for go without logic

templ works with go >= 1.0

Documentation

Index

• type Buffer
  • func (b *Buffer) Name() string
• type Escaper
  • func (esc Escaper) View(stru interface{}, tag string) *View
• type Placeholder
  • func NewPlaceholder(name string, escaper ...func(interface{}) string) Placeholder
  • func (p Placeholder) Name() string
  • func (p Placeholder) Set(val interface{}) Setter
  • func (p Placeholder) Setf(format string, vals ...interface{}) Setter
  • func (p Placeholder) WriteTo(w io.Writer) (int64, error)
• type Setter
• type Template
  • func New(name string) *Template
  • func (t *Template) Add(data ...interface{}) (err error)
  • func (t *Template) MustAdd(data ...interface{}) *Template
  • func (t *Template) MustParse() *Template
  • func (r *Template) MustReplace(setters ...Setter) (bf *Buffer)
  • func (r *Template) MustReplaceMixed(mixed ...interface{}) (bf *Buffer)
  • func (r *Template) MustReplaceMixedTo(b *bytes.Buffer, mixed ...interface{}) (bf *Buffer)
  • func (r *Template) MustReplaceTo(b *bytes.Buffer, setters ...Setter) *Buffer
  • func (t *Template) MustWrite(b []byte)
  • func (t *Template) MustWriteByte(b byte)
  • func (t *Template) MustWriteRune(r rune)
  • func (t *Template) MustWriteSetter(s Setter)
  • func (t *Template) MustWriteString(s string)
  • func (t *Template) MustWriteTo(w io.Writer)
  • func (t *Template) New() *Buffer
  • func (t *Template) Parse() error
  • func (r *Template) Replace(setters ...Setter) (bf *Buffer, errors map[string]error)
  • func (r *Template) ReplaceMixed(mixed ...interface{}) (bf *Buffer, errors map[string]error)
  • func (r *Template) ReplaceMixedTo(b *bytes.Buffer, mixed ...interface{}) (bf *Buffer, errors map[string]error)
  • func (r *Template) ReplaceTo(b *bytes.Buffer, setters ...Setter) (bf *Buffer, errors map[string]error)
  • func (t *Template) WriteSetter(p Setter) (err error)
• type View
  • func (str *View) HasPlaceholder(field string) bool
  • func (str *View) Placeholder(field string) Placeholder
  • func (str *View) Set(stru interface{}) (ss []Setter)
  • func (str *View) Tag() string
  • func (str *View) Type() string

Types

type Buffer

type Buffer struct {
	*bytes.Buffer
	// contains filtered or unexported fields
}

a named buffer, fullfills the Setter interface

func (*Buffer) Name

func (b *Buffer) Name() string

type Escaper

type Escaper map[string]func(interface{}) string

func (Escaper) View

func (esc Escaper) View(stru interface{}, tag string) *View

type Placeholder

type Placeholder struct {
	Value   string
	Escaper []func(interface{}) string
	// contains filtered or unexported fields
}

func NewPlaceholder

func NewPlaceholder(name string, escaper ...func(interface{}) string) Placeholder

func (Placeholder) Name

func (p Placeholder) Name() string

func (Placeholder) Set

func (p Placeholder) Set(val interface{}) Setter

func (Placeholder) Setf

func (p Placeholder) Setf(format string, vals ...interface{}) Setter

func (Placeholder) WriteTo

func (p Placeholder) WriteTo(w io.Writer) (int64, error)

type Setter

type Setter interface {
	io.WriterTo
	Name() string
}

type Template

type Template struct {
	*Buffer
	*replacer.Replacer
}

func New

func New(name string) *Template

func (*Template) Add

func (t *Template) Add(data ...interface{}) (err error)

func (*Template) MustAdd

func (t *Template) MustAdd(data ...interface{}) *Template

add data to the template

func (*Template) MustParse

func (t *Template) MustParse() *Template

func (*Template) MustReplace

func (r *Template) MustReplace(setters ...Setter) (bf *Buffer)

calls Must with a new buffer for every

func (*Template) MustReplaceMixed

func (r *Template) MustReplaceMixed(mixed ...interface{}) (bf *Buffer)

func (*Template) MustReplaceMixedTo

func (r *Template) MustReplaceMixedTo(b *bytes.Buffer, mixed ...interface{}) (bf *Buffer)

func (*Template) MustReplaceTo

func (r *Template) MustReplaceTo(b *bytes.Buffer, setters ...Setter) *Buffer

like New but doesn't return errors and panics instead

func (*Template) MustWrite

func (t *Template) MustWrite(b []byte)

func (*Template) MustWriteByte

func (t *Template) MustWriteByte(b byte)

func (*Template) MustWriteRune

func (t *Template) MustWriteRune(r rune)

func (*Template) MustWriteSetter

func (t *Template) MustWriteSetter(s Setter)

func (*Template) MustWriteString

func (t *Template) MustWriteString(s string)

func (*Template) MustWriteTo

func (t *Template) MustWriteTo(w io.Writer)

func (*Template) New

func (t *Template) New() *Buffer

func (*Template) Parse

func (t *Template) Parse() error

func (*Template) Replace

func (r *Template) Replace(setters ...Setter) (bf *Buffer, errors map[string]error)

calls Must with a new buffer for every

func (*Template) ReplaceMixed

func (r *Template) ReplaceMixed(mixed ...interface{}) (bf *Buffer, errors map[string]error)

func (*Template) ReplaceMixedTo

func (r *Template) ReplaceMixedTo(b *bytes.Buffer, mixed ...interface{}) (bf *Buffer, errors map[string]error)

func (*Template) ReplaceTo

func (r *Template) ReplaceTo(b *bytes.Buffer, setters ...Setter) (bf *Buffer, errors map[string]error)

func (*Template) WriteSetter

func (t *Template) WriteSetter(p Setter) (err error)

type View

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

func (*View) HasPlaceholder

func (str *View) HasPlaceholder(field string) bool

func (*View) Placeholder

func (str *View) Placeholder(field string) Placeholder

func (*View) Set

func (str *View) Set(stru interface{}) (ss []Setter)

func (*View) Tag

func (str *View) Tag() string

func (*View) Type

func (str *View) Type() string