type ExecError(struct)
ExecError is the custom error type returned when Execute has an
error evaluating its template. (If a write error occurs, the actual
error is returned; it will not be of type ExecError.)
Err is the underlying error.
Name is the file name for which the error occurred.
( T) Error() string( T) Unwrap() error
T : error
type FuncMap(map)
FuncMap is the type of the map defining the mapping from names to functions.
Each function must have either a single return value, or two return values of
which the second has type error. In that case, if the second (error)
return value evaluates to non-nil during execution, execution terminates and
Execute returns that error.
When template execution invokes a function with an argument list, that list
must be assignable to the function's parameter types. Functions meant to
apply to arguments of arbitrary type can use parameters of type interface{} or
of type reflect.Value. Similarly, functions meant to return a result of arbitrary
type can return interface{} or reflect.Value.
func (*Template).Funcs(funcMap FuncMap) *Template
type Template(struct)
Template is the representation of a parsed template. The *parse.Tree
field is exported only for use by html/template and should be treated
as unexported by all other clients.
Tree*parse.Tree
// name of the top-level template during parsing, for error messages.
// top-level root of the tree.
AddParseTree associates the argument parse tree with the template t, giving
it the specified name. If the template has not been defined, this tree becomes
its definition. If it has been defined and already has that name, the existing
definition is replaced; otherwise a new template is created, defined, and returned.
Clone returns a duplicate of the template, including all associated
templates. The actual representation is not copied, but the name space of
associated templates is, so further calls to Parse in the copy will add
templates to the copy but not to the original. Clone can be used to prepare
common templates and use them with variant definitions for other templates
by adding the variants after the clone is made.
Copy returns a copy of the Tree. Any parsing state is discarded.
DefinedTemplates returns a string listing the defined templates,
prefixed by the string "; defined templates are: ". If there are none,
it returns the empty string. For generating an error message here
and in html/template.
Delims sets the action delimiters to the specified strings, to be used in
subsequent calls to Parse, ParseFiles, or ParseGlob. Nested template
definitions will inherit the settings. An empty delimiter stands for the
corresponding default: {{ or }}.
The return value is the template, so calls can be chained.
ErrorContext returns a textual representation of the location of the node in the input text.
The receiver is only used when the node does not have a pointer to the tree inside,
which can occur in old code.
Execute applies a parsed template to the specified data object,
and writes the output to wr.
If an error occurs executing the template or writing its output,
execution stops, but partial results may already have been written to
the output writer.
A template may be executed safely in parallel, although if parallel
executions share a Writer the output may be interleaved.
If data is a reflect.Value, the template applies to the concrete
value that the reflect.Value holds, as in fmt.Print.
ExecuteTemplate applies the template associated with t that has the given name
to the specified data object and writes the output to wr.
If an error occurs executing the template or writing its output,
execution stops, but partial results may already have been written to
the output writer.
A template may be executed safely in parallel, although if parallel
executions share a Writer the output may be interleaved.
Funcs adds the elements of the argument map to the template's function map.
It must be called before the template is parsed.
It panics if a value in the map is not a function with appropriate return
type or if the name cannot be used syntactically as a function in a template.
It is legal to overwrite elements of the map. The return value is the template,
so calls can be chained.
Lookup returns the template with the given name that is associated with t.
It returns nil if there is no such template or the template has no definition.
Name returns the name of the template.
New allocates a new, undefined template associated with the given one and with the same
delimiters. The association, which is transitive, allows one template to
invoke another with a {{template}} action.
Because associated templates share underlying data, template construction
cannot be done safely in parallel. Once the templates are constructed, they
can be executed in parallel.
Option sets options for the template. Options are described by
strings, either a simple string or "key=value". There can be at
most one equals sign in an option string. If the option string
is unrecognized or otherwise invalid, Option panics.
Known options:
missingkey: Control the behavior during execution if a map is
indexed with a key that is not present in the map.
"missingkey=default" or "missingkey=invalid"
The default behavior: Do nothing and continue execution.
If printed, the result of the index operation is the string
"<no value>".
"missingkey=zero"
The operation returns the zero value for the map type's element.
"missingkey=error"
Execution stops immediately with an error.
Parse parses text as a template body for t.
Named template definitions ({{define ...}} or {{block ...}} statements) in text
define additional templates associated with t and are removed from the
definition of t itself.
Templates can be redefined in successive calls to Parse.
A template definition with a body containing only white space and comments
is considered empty and will not replace an existing template's body.
This allows using Parse to add new named template definitions without
overwriting the main template body.
ParseFiles parses the named files and associates the resulting templates with
t. If an error occurs, parsing stops and the returned template is nil;
otherwise it is t. There must be at least one file.
Since the templates created by ParseFiles are named by the base
names of the argument files, t should usually have the name of one
of the (base) names of the files. If it does not, depending on t's
contents before calling ParseFiles, t.Execute may fail. In that
case use t.ExecuteTemplate to execute a valid template.
When parsing multiple files with the same name in different directories,
the last one mentioned will be the one that results.
ParseGlob parses the template definitions in the files identified by the
pattern and associates the resulting templates with t. The files are matched
according to the semantics of filepath.Match, and the pattern must match at
least one file. ParseGlob is equivalent to calling t.ParseFiles with the
list of files matched by the pattern.
When parsing multiple files with the same name in different directories,
the last one mentioned will be the one that results.
Templates returns a slice of defined templates associated with t.
func Must(t *Template, err error) *Template
func New(name string) *Template
func ParseFiles(filenames ...string) (*Template, error)
func ParseGlob(pattern string) (*Template, error)
func (*Template).AddParseTree(name string, tree *parse.Tree) (*Template, error)
func (*Template).Clone() (*Template, error)
func (*Template).Delims(left, right string) *Template
func (*Template).Funcs(funcMap FuncMap) *Template
func (*Template).Lookup(name string) *Template
func (*Template).New(name string) *Template
func (*Template).Option(opt ...string) *Template
func (*Template).Parse(text string) (*Template, error)
func (*Template).ParseFiles(filenames ...string) (*Template, error)
func (*Template).ParseGlob(pattern string) (*Template, error)
func (*Template).Templates() []*Template
func Must(t *Template, err error) *Template
Exported Values
func HTMLEscape(w io.Writer, b []byte)
HTMLEscape writes to w the escaped HTML equivalent of the plain text data b.
func HTMLEscaper(args ...interface{}) string
HTMLEscaper returns the escaped HTML equivalent of the textual
representation of its arguments.
func HTMLEscapeString(s string) string
HTMLEscapeString returns the escaped HTML equivalent of the plain text data s.
func IsTrue(val interface{}) (truth, ok bool)
IsTrue reports whether the value is 'true', in the sense of not the zero of its type,
and whether the value has a meaningful truth value. This is the definition of
truth used by if and other such actions.
func JSEscape(w io.Writer, b []byte)
JSEscape writes to w the escaped JavaScript equivalent of the plain text data b.
func JSEscaper(args ...interface{}) string
JSEscaper returns the escaped JavaScript equivalent of the textual
representation of its arguments.
func JSEscapeString(s string) string
JSEscapeString returns the escaped JavaScript equivalent of the plain text data s.
func Must(t *Template, err error) *Template
Must is a helper that wraps a call to a function returning (*Template, error)
and panics if the error is non-nil. It is intended for use in variable
initializations such as
var t = template.Must(template.New("name").Parse("text"))
func New(name string) *Template
New allocates a new, undefined template with the given name.
func ParseFiles(filenames ...string) (*Template, error)
ParseFiles creates a new Template and parses the template definitions from
the named files. The returned template's name will have the base name and
parsed contents of the first file. There must be at least one file.
If an error occurs, parsing stops and the returned *Template is nil.
When parsing multiple files with the same name in different directories,
the last one mentioned will be the one that results.
For instance, ParseFiles("a/foo", "b/foo") stores "b/foo" as the template
named "foo", while "a/foo" is unavailable.
func ParseGlob(pattern string) (*Template, error)
ParseGlob creates a new Template and parses the template definitions from
the files identified by the pattern. The files are matched according to the
semantics of filepath.Match, and the pattern must match at least one file.
The returned template will have the (base) name and (parsed) contents of the
first file matched by the pattern. ParseGlob is equivalent to calling
ParseFiles with the list of files matched by the pattern.
When parsing multiple files with the same name in different directories,
the last one mentioned will be the one that results.
func URLQueryEscaper(args ...interface{}) string
URLQueryEscaper returns the escaped value of the textual representation of
its arguments in a form suitable for embedding in a URL query.
The pages are generated with Goldsv0.1.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project and developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.
