tpl

Documentation

Overview

Package tpl provides a way to parse a template string and inject secret values into it.

Index

• Constants
• Variables
• type Template
  • func New(raw string) (*Template, error)
  • func (t *Template) Inject(secrets map[api.SecretPath][]byte) (string, error)

Constants

const (
	// DefaultStartDelimiter defines the characters a template block starts with.
	DefaultStartDelimiter = "${"
	// DefaultEndDelimiter defines the characters a template block ends with.
	DefaultEndDelimiter = "}"
	// DefaultTrimChars defines the cutset of characters that will be trimmed from template blocks.
	DefaultTrimChars = " "
)

Variables

var (
	ErrParseFailed    = errInject.Code("parse_failed").ErrorPref("failed to parse contents: %v")
	ErrSecretNotFound = errInject.Code("secret_not_found").ErrorPref("no secret found to inject for path %s")
)

Errors

Types

type Template

type Template struct {
	Raw     string
	Secrets []api.SecretPath
	// contains filtered or unexported fields
}

Template helps with injecting values into strings that contain the template syntax.

func New

func New(raw string) (*Template, error)

New creates a new template and parses it.

func (*Template) Inject

func (t *Template) Inject(secrets map[api.SecretPath][]byte) (string, error)

Inject inserts the given secrets at their corresponding places in the raw template and returns the injected template.