render

Documentation

Overview

Package render defines the standard interface for template rendering.

Index

• type JSON
  • func (j JSON) Render(ctx context.Context, w io.Writer, data interface{}) error
• type MockRenderer
  • func (m *MockRenderer) Render(ctx context.Context, w io.Writer, data interface{}) error
• type MockTemplater
  • func (m *MockTemplater) Template(name string) (Renderer, error)
• type Renderer
• type Templater
• type XML
  • func (x XML) Render(ctx context.Context, w io.Writer, data interface{}) error

Types

type JSON

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

JSON implements a JSON renderer.

func (JSON) Render

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

Render renders data as JSON to w.

type MockRenderer

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

MockRenderer is a test mock for the Renderer interface.

func (*MockRenderer) Render

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

type MockTemplater

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

MockTemplater is a test mock for the Templater interface.

func (*MockTemplater) Template

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

type Renderer

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

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

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

XML implements an XML renderer.

func (XML) Render

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

Render renders data as XML to w.