BencheeDsl v0.1.4

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

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

Callbacks

run()

Runs the benchmark.

run(config)

Runs the benchmark with the given config.

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

Link to this type

keys()

View Source 
@type keys() :: :config | :description | :dir | :module | :title
Link to this type

t()

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

Link to this section Callbacks

Link to this callback

run()

View Source 
@callback run() :: :ok

Runs the benchmark.

Link to this callback

run(config)

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

Runs the benchmark with the given config.

Link to this section Functions

Link to this macro

config(config)

View Source (macro)

Configures the benchmark.

Link to this macro

formatter(module, opts)

View Source (macro)

Adds a formatter to the benchmark.

Link to this macro

inputs(inputs)

View Source (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.

Link to this macro

job(fun)

View Source (macro)

This macro defines a function for the benchmark.

Link to this macro

job(fun, list)

View Source (macro)
Link to this macro

job(fun_name, var, list)

View Source (macro)
Link to this macro

jobs(list)

View Source (macro)

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

Link to this macro

jobs(var, list)

View Source (macro)

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

Link to this function

new(data)

View Source 
@spec new(keyword()) :: t()

Creates a new Benchmark struct.

Link to this macro

on_exit(fun)

View Source (macro)

Defines a callback that runs once the benchmark exits.

Link to this macro

setup(list)

View Source (macro)

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

Link to this function

update(benchmark, key, fun)

View Source 
@spec update(t(), keys() | [atom()], (any() -> any())) :: t()

Updates a benchmark struct by the given key or path.