axis

Documentation

Index

• func NewBenchmarks(benchWeight map[BenchValue]uint, summaryHTML template.HTML, ...) score.Axis
• func NewWarnings(levelWeight map[warning.Level]uint, summaryHTML template.HTML) score.Axis
• func Setup() error
• type BenchOptions
• type BenchValue
• type Benchmarks
  • func (b *Benchmarks) Documentation() template.HTML
  • func (b *Benchmarks) Exhibits() []score.Exhibit
  • func (b *Benchmarks) Name() string
  • func (b *Benchmarks) ScoreFor(handler data.HandlerTag) score.Value
  • func (b *Benchmarks) Setup(bench *data.Benchmarks, _ *data.Warnings) error
  • func (b *Benchmarks) Summary() template.HTML
• type Warnings
  • func (w *Warnings) Documentation() template.HTML
  • func (w *Warnings) Exhibits() []score.Exhibit
  • func (w *Warnings) Name() string
  • func (w *Warnings) ScoreFor(handler data.HandlerTag) score.Value
  • func (w *Warnings) Setup(_ *data.Benchmarks, warns *data.Warnings) error
  • func (w *Warnings) Summary() template.HTML

Functions

func NewBenchmarks

func NewBenchmarks(benchWeight map[BenchValue]uint, summaryHTML template.HTML, options *BenchOptions) score.Axis

func NewWarnings

func NewWarnings(levelWeight map[warning.Level]uint, summaryHTML template.HTML) score.Axis

func Setup

func Setup() error

Types

type BenchOptions

type BenchOptions struct {
	Name         string
	IncludeTests []data.TestTag
	ExcludeTests []data.TestTag
}

type BenchValue

type BenchValue string

const (
	Allocations BenchValue = "Allocations"
	AllocBytes  BenchValue = "Alloc Bytes"
	Nanoseconds BenchValue = "Nanoseconds"
)

type Benchmarks

type Benchmarks struct {
	BenchOptions
	// contains filtered or unexported fields
}

func (*Benchmarks) Documentation

func (b *Benchmarks) Documentation() template.HTML

func (*Benchmarks) Exhibits

func (b *Benchmarks) Exhibits() []score.Exhibit

func (*Benchmarks) Name

func (b *Benchmarks) Name() string

func (*Benchmarks) ScoreFor

func (b *Benchmarks) ScoreFor(handler data.HandlerTag) score.Value

func (*Benchmarks) Setup

func (b *Benchmarks) Setup(bench *data.Benchmarks, _ *data.Warnings) error

func (*Benchmarks) Summary

func (b *Benchmarks) Summary() template.HTML

type Warnings

type Warnings struct {
	// contains filtered or unexported fields
}

func (*Warnings) Documentation

func (w *Warnings) Documentation() template.HTML

func (*Warnings) Exhibits

func (w *Warnings) Exhibits() []score.Exhibit

func (*Warnings) Name

func (w *Warnings) Name() string

func (*Warnings) ScoreFor

func (w *Warnings) ScoreFor(handler data.HandlerTag) score.Value

func (*Warnings) Setup

func (w *Warnings) Setup(_ *data.Benchmarks, warns *data.Warnings) error

func (*Warnings) Summary

func (w *Warnings) Summary() template.HTML