report

Documentation

Overview

Package report generates human-readable benchmark reports.

Index

• type Report
  • func NewReport(precision string) Report
  • func NewReportRate(precision string) Report
  • func NewReportSample(precision string) Report
• type Result
  • func (res *Result) Duration() time.Duration
• type TimeSeries
  • func (t TimeSeries) Len() int
  • func (t TimeSeries) Less(i, j int) bool
  • func (ts TimeSeries) String() string
  • func (t TimeSeries) Swap(i, j int)

Types

type Report

type Report interface {
	Results() chan<- Result
	Run() <-chan string
	String() string
}

Report processes a result stream until it is closed, then produces a string with information about the consumed result data.

func NewReport

func NewReport(precision string) Report

func NewReportRate

func NewReportRate(precision string) Report

func NewReportSample

func NewReportSample(precision string) Report

type Result

type Result struct {
	Start time.Time
	End   time.Time
	Err   error
}

Result describes the timings for an operation.

func (*Result) Duration

func (res *Result) Duration() time.Duration

type TimeSeries

type TimeSeries []timeSeries

func (TimeSeries) Len

func (t TimeSeries) Len() int

func (TimeSeries) Less

func (t TimeSeries) Less(i, j int) bool

func (TimeSeries) String

func (ts TimeSeries) String() string

func (TimeSeries) Swap

func (t TimeSeries) Swap(i, j int)