BencheeDsl.Benchmark (BencheeDsl v0.1.2) View Source

Helpers for defining a benchmark with the DSL.

This module must be used to define and configure a benchmark.

Link to this section Summary

Types

keys()

t()

Functions

config(config)

Configures the benchmark.

formatter(module, opts)

Adds a formatter to the benchmark.

inputs(inputs)

Defines a function or map to setup the inputs for the benchmark. If inputs has a do block a map is expected to be returned.

job(fun)

This macro defines a function for the benchmark.

job(fun, list)

job(fun_name, var, list)

jobs(list)

Overwrites the job map. This function can be used to set up jobs dynamically.

jobs(var, list)

Updates the job map. This function can be used to set up jobs dynamically.

new(data)

Creates a new Benchmark struct.

on_exit(fun)

Defines a callback that runs once the benchmark exits.

setup(list)

Defines a setup callback to be run before the benchmark starts.

update(benchmark, key, fun)

Updates a benchmark struct by the given key or path.

Link to this section Types

keys()

Specs

keys() :: :config | :description | :dir | :module | :title

t()

Specs

t() :: %BencheeDsl.Benchmark{
  config: keyword(),
  description: String.t(),
  dir: String.t(),
  module: module(),
  title: String.t()
}

Link to this section Functions

config(config)

(macro)

Configures the benchmark.

formatter(module, opts)

(macro)

Adds a formatter to the benchmark.

inputs(inputs)

(macro)

Defines a function or map to setup the inputs for the benchmark. If inputs has a do block a map is expected to be returned.

job(fun)

(macro)

This macro defines a function for the benchmark.

job(fun, list)

(macro)

job(fun_name, var, list)

(macro)

jobs(list)

(macro)

Overwrites the job map. This function can be used to set up jobs dynamically.

jobs(var, list)

(macro)

Updates the job map. This function can be used to set up jobs dynamically.

new(data)

Specs

new(keyword()) :: t()

Creates a new Benchmark struct.

on_exit(fun)

(macro)

Defines a callback that runs once the benchmark exits.

setup(list)

(macro)

Defines a setup callback to be run before the benchmark starts.

update(benchmark, key, fun)

Specs

update(t(), keys() | [atom()], (any() -> any())) :: t()

Updates a benchmark struct by the given key or path.