tmpl

Documentation

Index

• type StrTmpl
  • func MustNewStrTmpl(tmplRaw string) *StrTmpl
  • func NewStrTmpl(tmpl string) (*StrTmpl, error)
  • func (t *StrTmpl) Execute(params any) (string, error)
• type Tmpl
  • func MustNewTmpl(tmplRaw string) *Tmpl
  • func New(tmplRaw string) (*Tmpl, error)
  • func (t *Tmpl) Execute(params any) ([]byte, error)
• type URLTmpl
  • func MustNewURLTmpl(tmplRaw string) *URLTmpl
  • func NewURLTmpl(tmpl string) (*URLTmpl, error)
  • func (t *URLTmpl) Execute(params any) (string, error)

Types

type StrTmpl

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

func MustNewStrTmpl

func MustNewStrTmpl(tmplRaw string) *StrTmpl

MustNewStrTmpl creates a new StrTmpl from the provided raw template string. It takes tmplRaw of type string. It returns a pointer to StrTmpl. It panics if there is an error during the creation of the StrTmpl.

func NewStrTmpl

func NewStrTmpl(tmpl string) (*StrTmpl, error)

NewStrTmpl creates a new StrTmpl instance by parsing the provided template string. It takes tmpl of type string, which is the template to be parsed. It returns a pointer to StrTmpl and an error. It returns an error if the template parsing fails.

func (*StrTmpl) Execute

func (t *StrTmpl) Execute(params any) (string, error)

Execute processes the given parameters using a JSON template and returns the resulting string. It takes params of type any, which represents the data to be used in the template. It returns a string containing the processed template and an error if the operation fails. It returns an error if the parameters cannot be marshaled into JSON, if the template execution fails, or if the template path does not resolve to a string.

type Tmpl

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

func MustNewTmpl

func MustNewTmpl(tmplRaw string) *Tmpl

MustNewTmpl creates a new Tmpl instance from the provided raw template string. It takes tmplRaw of type string, which is the raw template content. It returns a pointer to a Tmpl instance. It panics if there is an error during the creation of the Tmpl instance.

func New

func New(tmplRaw string) (*Tmpl, error)

New creates a new Tmpl instance from a raw JSON template string. It takes tmplRaw of type string, which is the raw JSON template. It returns a pointer to Tmpl and an error. It returns an error if the template parsing fails.

func (*Tmpl) Execute

func (t *Tmpl) Execute(params any) ([]byte, error)

Execute processes the provided data using the template and returns the result as a byte slice. It takes one parameter: data of type []byte, which represents the input data to be processed by the template. It returns a byte slice containing the processed data and an error if the template execution fails. It returns an error if the template execution encounters any issues, such as invalid data or template errors.

type URLTmpl

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

func MustNewURLTmpl

func MustNewURLTmpl(tmplRaw string) *URLTmpl

MustNewURLTmpl creates a new URLTmpl from the given raw template string. It takes tmplRaw of type string. It returns a pointer to a URLTmpl. It panics if the template string is invalid or if there is an error during the creation of the URLTmpl.

func NewURLTmpl

func NewURLTmpl(tmpl string) (*URLTmpl, error)

NewURLTmpl creates a new URLTmpl instance by parsing the provided template string. It takes tmpl of type string, which represents the template to be parsed. It returns a pointer to a URLTmpl and an error. It returns an error if the template parsing fails.

func (*URLTmpl) Execute

func (t *URLTmpl) Execute(params any) (string, error)

Execute generates a URL string by executing a template with the provided parameters. It takes params of type any, which are marshaled into JSON and used to fill the template. It returns a string containing the generated URL and an error if the operation fails. It returns an error if the parameters cannot be marshaled into JSON, if the template execution fails, or if the template path does not resolve to a string value.