View Source Beamchmark.Scenario behaviour (Beamchmark v1.4.0)
Scenario to run during benchmarking. Defines a behaviour that needs to be adopted by benchmarked modules.
Beamchmark
will call the implementation of run/0
in a new process, shutting it down once it completes all
measurements. The implementation should run for a longer period of time (possibly infinite) than measurements,
so that the EVM isn't benchmarked while it's idle. For the same reason, it is recommended to raise
immediately
in case the implementation fails.
Link to this section Summary
Types
Represents a module implementing Beamchmark.Scenario
behaviour.
Link to this section Types
Specs
t() :: module()
Represents a module implementing Beamchmark.Scenario
behaviour.
Link to this section Callbacks
Specs
run() :: any()
The function that will be called during benchmarking.