template

Documentation

Overview

Package template provides protocol template system for rapid protocol creation.

Index

• func FormatList(templates []Template) string
• func Render(tmpl *Template, vars map[string]string) string
• type Template
  • func BuiltinTemplates() []Template
• type Variable

Functions

func FormatList

func FormatList(templates []Template) string

FormatList formats template list for display.

func Render

func Render(tmpl *Template, vars map[string]string) string

Render renders a template with the given variables.

Types

type Template

type Template struct {
	Name        string     `json:"name"`
	Description string     `json:"description"`
	Category    string     `json:"category"` // "tlv", "rpc", "stream", "request-response"
	Variables   []Variable `json:"variables"`
	Body        string     `json:"body"`
}

Template represents a protocol template.

func BuiltinTemplates

func BuiltinTemplates() []Template

BuiltinTemplates returns all built-in protocol templates.

type Variable

type Variable struct {
	Name    string `json:"name"`
	Default string `json:"default"`
	Desc    string `json:"description"`
}

Variable represents a template variable.