templates

Documentation

Index

• func Apply(field string, values any) (string, error)
• func ApplyAndSet(field *string, values any) (err error)
• type Option
  • func WithMissingKeyDefault() Option
  • func WithMissingKeyError() Option
  • func WithMissingKeyZero() Option
  • func WithSlimSprig() Option
• type Processor
  • func New(opts ...Option) *Processor
  • func (p *Processor) AddFuncs(funcs ...template.FuncMap)
  • func (p *Processor) AddValue(key string, value any)
  • func (p *Processor) AddValues(values ...map[string]any)
  • func (p *Processor) Apply(templateStr string) (string, error)
  • func (p *Processor) ApplyAndSet(field *string) error
  • func (p *Processor) Reset()
  • func (p *Processor) Values() map[string]any
  • func (p *Processor) WithOptions(opts ...Option) *Processor
  • func (p *Processor) WithValues(values ...map[string]any) *Processor

Functions

func Apply

func Apply(field string, values any) (string, error)

func ApplyAndSet

func ApplyAndSet(field *string, values any) (err error)

Types

type Option

type Option func(*Processor)

Option is a function that modifies a Processor.

func WithMissingKeyDefault

func WithMissingKeyDefault() Option

WithMissingKeyDefault sets missing keys to display "<no value>".

func WithMissingKeyError

func WithMissingKeyError() Option

WithMissingKeyError makes missing keys return an error.

func WithMissingKeyZero

func WithMissingKeyZero() Option

WithMissingKeyZero sets missing keys to use the zero value.

func WithSlimSprig

func WithSlimSprig() Option

WithSlimSprig adds slim-sprig functions.

type Processor

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

Processor handles template processing with configurable options.

func New

func New(opts ...Option) *Processor

New creates a processor with the given options.

func (*Processor) AddFuncs

func (p *Processor) AddFuncs(funcs ...template.FuncMap)

AddFuncs adds or updates multiple functions.

func (*Processor) AddValue

func (p *Processor) AddValue(key string, value any)

AddValue adds or updates a single value.

func (*Processor) AddValues

func (p *Processor) AddValues(values ...map[string]any)

AddValues adds or updates multiple values.

func (*Processor) Apply

func (p *Processor) Apply(templateStr string) (string, error)

Apply processes a template string with the accumulated values.

func (*Processor) ApplyAndSet

func (p *Processor) ApplyAndSet(field *string) error

func (*Processor) Reset

func (p *Processor) Reset()

Reset clears all accumulated values.

func (*Processor) Values

func (p *Processor) Values() map[string]any

func (*Processor) WithOptions

func (p *Processor) WithOptions(opts ...Option) *Processor

func (*Processor) WithValues

func (p *Processor) WithValues(values ...map[string]any) *Processor