View Source BencheeDsl.Benchmark behaviour (BencheeDsl v0.5.3)

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

key()

t()

Callbacks

run()

Runs the benchmark.

run(config)

Runs the benchmark with the given config.

Functions

after_each(list)

Defines a after_each hook.

after_each(var, list)

Defines a after_each hook.

after_scenario(list)

Defines a after_scenario hook.

after_scenario(var, list)

Defines a after_scenario hook.

before_each(list)

Defines a before_each hook.

before_each(var, list)

Defines a before_each hook.

before_scenario(list)

Defines a before_scenario hook.

before_scenario(var, list)

Defines a before_scenario hook.

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(module)

Takes a module and generates jobs for each public function.

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

key()

@type key() :: :config | :description | :dir | :module

t()

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

Link to this section Callbacks

run()

@callback run() :: :ok

Runs the benchmark.

run(config)

@callback run(config :: keyword()) :: :ok

Runs the benchmark with the given config.

Link to this section Functions

after_each(list)

(macro)

Defines a after_each hook.

after_each(var, list)

(macro)

Defines a after_each hook.

after_scenario(list)

(macro)

Defines a after_scenario hook.

after_scenario(var, list)

(macro)

Defines a after_scenario hook.

before_each(list)

(macro)

Defines a before_each hook.

before_each(var, list)

(macro)

Defines a before_each hook.

before_scenario(list)

(macro)

Defines a before_scenario hook.

before_scenario(var, list)

(macro)

Defines a before_scenario hook.

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(module)

(macro)

Takes a module and generates jobs for each public function.

new(data)

@spec 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)

@spec update(t(), key() | [atom()], (any() -> any())) :: t()

Updates a benchmark struct by the given key or path.

Settings View Source BencheeDsl.Benchmark behaviour (BencheeDsl v0.5.3)

Link to this section Summary

Types

Callbacks

Functions

Link to this section Types

key()

t()

Link to this section Callbacks

run()

run(config)

Link to this section Functions

after_each(list)

after_each(var, list)

after_scenario(list)

after_scenario(var, list)

before_each(list)

before_each(var, list)

before_scenario(list)

before_scenario(var, list)

config(config)

formatter(module, opts)

inputs(inputs)

job(fun)

job(fun, list)

job(fun_name, var, list)

jobs(module)

new(data)

on_exit(fun)

setup(list)

update(benchmark, key, fun)

View Source BencheeDsl.Benchmark behaviour (BencheeDsl v0.5.3)