template

Documentation

Index

• Constants
• func DefaultFuncMap() template.FuncMap
• func DerefString(s *string) string
• func Link(server, file string) string
• type Blackbox
• type Client
  • func NewClient(opts ClientOptions) (Client, error)
• type ClientOption
  • func WithTemplatesFS(x fs.FS) ClientOption
  • func WithTemplatesPath(x string) ClientOption
• type ClientOptions
  • func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
• type DefaultTool
  • func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
  • func (d *DefaultTool) Render(ctx context.Context, opts contract.RenderOptions) error
• type Tool

Constants

const (
	FuncDerefString = "derefString"
	FuncLink        = "link"
)

Functions

func DefaultFuncMap

func DefaultFuncMap() template.FuncMap

DefaultFuncMap returns the default template function map.

func DerefString

func DerefString(s *string) string

DerefString returns the string value or empty if nil.

func Link

func Link(server, file string) string

Link returns a joined URL from server and file.

Types

type Blackbox

type Blackbox interface {
	// contains filtered or unexported methods
}

type Client

type Client interface {
	Blackbox
	contract.TemplateOperator
}

func NewClient

func NewClient(opts ClientOptions) (Client, error)

type ClientOption

type ClientOption = contract.Opt[ClientOptions]

func WithTemplatesFS

func WithTemplatesFS(x fs.FS) ClientOption

func WithTemplatesPath

func WithTemplatesPath(x string) ClientOption

type ClientOptions

type ClientOptions struct {
	TemplatesFS   fs.FS
	TemplatesPath string
}

func ApplyClientOptions

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (*DefaultTool) Render

func (d *DefaultTool) Render(ctx context.Context, opts contract.RenderOptions) error

Render renders a template with the given options.

type Tool

type Tool interface {
	contract.TemplateOperator
}