render

package

v0.0.0-...-e1e9d1d Latest Latest Go to latest Published: May 20, 2021 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package render defines the standard interface for template rendering.

This section is empty.

This section is empty.

This section is empty.

type JSON struct {
	// Pretty indicates if whitespace and newlines should be used.
	Pretty bool
}

JSON implements a JSON renderer.

func (j JSON) Render(ctx context.Context, w io.Writer, data interface{}) error

Render renders data as JSON to w.

type MockRenderer struct {
	RenderFunc func(context.Context, io.Writer, interface{}) error
}

MockRenderer is a test mock for the Renderer interface.

func (m *MockRenderer) Render(ctx context.Context, w io.Writer, data interface{}) error

type MockTemplater struct {
	TemplateFunc func(string) (Renderer, error)
}

MockTemplater is a test mock for the Templater interface.

func (m *MockTemplater) Template(name string) (Renderer, error)

type Renderer interface {
	Render(ctx context.Context, w io.Writer, data interface{}) error
}

Renderer defines the method to render data to a writer. Examples of renderers may be HTML templates, Email templates, JSON documents, etc.

type Templater interface {
	Template(name string) (Renderer, error)
}

Templater defines the method to get a named Renderer. It returns an error if no Renderer exists for this name.

type XML struct {
	// Pretty indicates if whitespace and newlines should be used.
	Pretty bool
}

XML implements an XML renderer.

func (x XML) Render(ctx context.Context, w io.Writer, data interface{}) error

Render renders data as XML to w.