evaluator

Documentation

Index

• type Driver
• type DriverContext
• type Environment
  • func NewEnvironment(fsys fs.FS, props map[string]any, hooksAPI HooksAPI) *Environment
  • func (env *Environment) Include(name string) string
  • func (env *Environment) Props() map[string]any
  • func (env *Environment) RegisterHooks(register func(name string, value any) error) error
  • func (env *Environment) Template(name string, props map[string]any) string
• type Evaluator
  • func New(driver Driver, hooks HooksAPI) *Evaluator
  • func (r *Evaluator) Render(doc *ast.Document, env *Environment) (string, error)
• type HooksAPI
• type RegisterHooks

Types

type Driver

type Driver interface {
	// CreateContext creates a new evaluation context.
	CreateContext(*Environment) (DriverContext, error)
}

Driver represents a template evaluation driver.

type DriverContext

type DriverContext interface {
	// Eval evaluates the provided code and returns the result.
	Eval(code string) (string, error)
}

DriverContext represents the context for template evaluation.

type Environment

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

Environment represents the environment for template evaluation.

func NewEnvironment

func NewEnvironment(fsys fs.FS, props map[string]any, hooksAPI HooksAPI) *Environment

NewEnvironment creates a new instance of Environment with the given parameters.

func (*Environment) Include

func (env *Environment) Include(name string) string

Include includes the template specified by name.

func (*Environment) Props

func (env *Environment) Props() map[string]any

Props returns the properties associated with the environment.

func (*Environment) RegisterHooks

func (env *Environment) RegisterHooks(register func(name string, value any) error) error

func (*Environment) Template

func (env *Environment) Template(name string, props map[string]any) string

Template renders the template specified by name with the given properties.

type Evaluator

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

Evaluator represents a template evaluator.

func New

func New(driver Driver, hooks HooksAPI) *Evaluator

New creates a new instance of Evaluator with the given driver and hooks.

func (*Evaluator) Render

func (r *Evaluator) Render(doc *ast.Document, env *Environment) (string, error)

Render renders the given abstract syntax tree document with the provided environment.

type HooksAPI

type HooksAPI interface {
	// Include includes the specified template.
	Include(string) (string, error)
	// Render renders the specified template with the given properties.
	Render(string, map[string]any) (string, error)
}

HooksAPI represents an interface for interacting with template hooks.

type RegisterHooks

type RegisterHooks interface {
	Register(onError func(error), reg func(name string, value any) error) error
}

RegisterHooks represents an interface for registering custom hooks