Benchee v0.14.0 Benchee.Suite View Source

Main benchee data structure that aggregates the results from every step.

Different layers of the benchmarking rely on different data being present here. For instance for Benchee.Statistics.statistics/1 to work the run_times key needs to be filled with the results from Benchee.Benchmark.measure/1.

Formatters can then use the data to display all of the results and the configuration.

Link to this section Summary

Link to this section Types

Link to this type

optional_map() View Source
optional_map() :: map() | nil

Link to this type

t() View Source
t() :: %Benchee.Suite{
  configuration: Benchee.Configuration.t() | nil,
  scenarios: [] | [Benchee.Benchmark.Scenario.t()],
  system: optional_map()
}