viewer

Documentation

Index

• type Perf
• type ProgressMessage
• type RenderFlags
  • func (rf RenderFlags) CSPHeader() string
  • func (rf RenderFlags) PublicURIS() (public []string)
• type Viewer
  • func NewViewer(writer io.Writer) *Viewer
  • func (viewer *Viewer) Close() error
  • func (viewer *Viewer) Perf() Perf
  • func (viewer *Viewer) Prepare(cache *sparkl.Cache, pb *pathbuilder.Pathbuilder)
  • func (viewer *Viewer) ServeHTTP(w http.ResponseWriter, r *http.Request)

Types

type Perf

type Perf struct {
	Stages []stats.StageStats
	Index  igraph.Stats
	Now    perf.Snapshot
}

Perf represents viewer performance

type ProgressMessage

type ProgressMessage struct {
	Message  string
	Progress stats.Progress
}

ProgressMessage is returned by the viewer when the progress is not available

type RenderFlags

type RenderFlags struct {
	PublicURL   string
	Predicates  sparkl.Predicates
	StrictCSP   bool // use strict content-security-policy for images and media by only allowing content from public uris
	HTMLRender  bool
	ImageRender bool

	// Stats holds the status to use for logging
	Stats *stats.Stats
}

func (RenderFlags) CSPHeader

func (rf RenderFlags) CSPHeader() string

CSPHeader returns the CSPHeader to be included in viewer responses

func (RenderFlags) PublicURIS

func (rf RenderFlags) PublicURIS() (public []string)

type Viewer

type Viewer struct {
	Stats *stats.Stats // Stats holds the current stats of the viewer

	Cache       *sparkl.Cache
	Pathbuilder *pathbuilder.Pathbuilder
	RenderFlags RenderFlags

	Footer template.HTML // html to include in footer of every page
	// contains filtered or unexported fields
}

Viewer implements an http.Handler that displays WissKI Entities.

func NewViewer

func NewViewer(writer io.Writer) *Viewer

NewViewer creates a new viewer that logs to the given output

func (*Viewer) Close

func (viewer *Viewer) Close() error

func (*Viewer) Perf

func (viewer *Viewer) Perf() Perf

func (*Viewer) Prepare

func (viewer *Viewer) Prepare(cache *sparkl.Cache, pb *pathbuilder.Pathbuilder)

func (*Viewer) ServeHTTP

func (viewer *Viewer) ServeHTTP(w http.ResponseWriter, r *http.Request)