context

Documentation

Index

• Constants
• type Cache
• type Context
  • func New() *Context
  • func (ctx *Context) RenderPlatform() string

Constants

const (
	// OperationListCommands operation
	OperationListCommands = "list-commands"
	// OperationListPlatforms operation
	OperationListPlatforms = "list-platforms"
	// OperationRenderPage operation
	OperationRenderPage = "render-page"
)

Types

type Cache

type Cache struct {
	Location string
	Remote   string
	TTL      time.Duration
}

Cache struct for working with the cache

type Context

type Context struct {
	ctx.Context
	PurgeCache         bool
	Platform           string
	Random             bool
	Cache              Cache
	PagesDirectory     string
	PageSuffix         string
	FoundPlatform      string
	Reader             io.ReadCloser
	Page               string
	Args               string
	AvailablePlatforms []string
	Color              bool
	Writer             io.Writer
	Operation          string
}

Context carries state through pipes

func New

func New() *Context

New creates a new context

func (*Context) RenderPlatform

func (ctx *Context) RenderPlatform() string

RenderPlatform formats the platform as `requested (actual)`