format

Documentation

Overview

Package format contains various formatting tools wrapped around text/template

Index

• Variables
• type Format
  • func (f *Format) Compile(name string, root *template.Template, funcMaps ...template.FuncMap) error
  • func (f *Format) Execute(data interface{}) (string, error)
  • func (f *Format) ExecuteBytes(data interface{}) ([]byte, error)
• type Storage
  • func (s *Storage) Delete(name string) string
  • func (s *Storage) GetBool(name string, def bool) bool
  • func (s *Storage) GetInt(name string, def int) int
  • func (s *Storage) GetString(name, def string) string
  • func (s *Storage) SetBool(name string, data bool) bool
  • func (s *Storage) SetInt(name string, i int) int
  • func (s *Storage) SetString(name, data string) string

Variables

var (
	// ErrEmptyFormat Is returned when the format is empty
	ErrEmptyFormat = errors.New("format: cannot compile an empty format")
)

var UtilFuncs = template.FuncMap{
	"zwsp":     util.AddZwsp,
	"wordEOL":  util.WordEol,
	"escape":   util.EscapeString,
	"stripAll": util.StripAll,
	"eat":      func(...interface{}) string { return "" },
}

UtilFuncs is a standard set of functions added to all Format's template.Template

Types

type Format

type Format struct {
	FormatString   string             `xml:",chardata"` // The original format string
	CompiledFormat *template.Template `xml:"-"`         // Our internal template
	// contains filtered or unexported fields
}

Format represents a wrapped template.Template

func (*Format) Compile

func (f *Format) Compile(name string, root *template.Template, funcMaps ...template.FuncMap) error

Compile compiles the given format string into a text.template, evaluating IRC colours if requested, and adding the default functions plus any passed to the template. If the template is invalid or the format has already been compiled, Compile errors. An optional root text/template can be passed, and if so, the compiled format's internal template will be associated with the passed root

func (*Format) Execute

func (f *Format) Execute(data interface{}) (string, error)

Execute runs a compiled Format and returns the resulting string

func (*Format) ExecuteBytes

func (f *Format) ExecuteBytes(data interface{}) ([]byte, error)

ExecuteBytes is like Execute but returns a slice of bytes

type Storage

type Storage struct {
	sync.RWMutex // Lets not have lists explode
	// contains filtered or unexported fields
}

Storage holds data for cross-execution storage

func (*Storage) Delete

func (s *Storage) Delete(name string) string

Delete deletes an entry from the Storage, It will not error if the entry does not exist

func (*Storage) GetBool

func (s *Storage) GetBool(name string, def bool) bool

GetBool returns either the bool stored at `testName` or a default

func (*Storage) GetInt

func (s *Storage) GetInt(name string, def int) int

GetInt returns either the int stored at `testName` or a default

func (*Storage) GetString

func (s *Storage) GetString(name, def string) string

GetString returns either the string stored at `testName` or a default

func (*Storage) SetBool

func (s *Storage) SetBool(name string, data bool) bool

SetBool sets the bool at `testName` to `data`

func (*Storage) SetInt

func (s *Storage) SetInt(name string, i int) int

SetInt sets the int at `testName` to `data`

func (*Storage) SetString

func (s *Storage) SetString(name, data string) string

SetString sets the string at `testName` to `data`