loaders

type CachedLoader ¶

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

CachedLoader represents a cached loader for templates. It wraps another loader and caches the loaded templates.

func NewCachedLoader(loader Loader) *CachedLoader

func (fs *CachedLoader) Clear()

func (fs *CachedLoader) Load(name string, cfg *exec.EvalConfig) (*exec.Template, error)

type FilesystemLoader ¶

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

FilesystemLoader represents a local filesystem loader for templates.

Search paths can be relative or absolute. Relative paths are relative to the current working directory. For security reasons, the loader prevents access to files outside of the search paths. This means that path traversal using `../` is not possible.

If you want to improve performance, you can use the CachedLoader to cache the loaded templates. Simply wrap the FilesystemLoader with the CachedLoader like this:

loader := loaders.NewCachedLoader(loaders.MustNewFileSystemLoader("templates"))

func MustNewFileSystemLoader(searchPaths ...string) *FilesystemLoader

func MustNewFileSystemLoaderWithOptions(
	encoding encoding.Encoding,
	followLinks bool,
	searchPaths ...string,
) *FilesystemLoader

func NewFileSystemLoader(searchPaths ...string) (*FilesystemLoader, error)

func NewFileSystemLoaderWithOptions(
	encoding encoding.Encoding,
	followLinks bool,
	searchPaths ...string,
) (loader *FilesystemLoader, err error)

func (fs *FilesystemLoader) Load(name string, cfg *exec.EvalConfig) (*exec.Template, error)

type Loader ¶

type Loader interface {
	// Load returns a template by name.
	Load(name string, cfg *exec.EvalConfig) (*exec.Template, error)
}

Loader is an interface for loading templates by name.

type MergedLoader ¶

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

MergedLoader represents a merged loader for templates. It wraps multiple loaders and returns the first found template.

func NewMergedLoader(loaders ...Loader) *MergedLoader

func (fs *MergedLoader) Load(name string, cfg *exec.EvalConfig) (*exec.Template, error)

type NullLoader ¶

type NullLoader struct{}

NullLoader represents a loader that refuses to load anything.

func NewNullLoader() *NullLoader

func (fs *NullLoader) Load(name string, _ *exec.EvalConfig) (*exec.Template, error)