Benchee v0.12.0 Benchee.Formatter behaviour View Source
Defines a behaviour for formatters in Benchee, and also defines functions to handle invoking that defined behavior.
When implementing a benchee formatter as a behaviour please adopt this
behaviour, as it helps with uniformity and also allows at least the .format
function of formatters to be run in parallel.
Even better, do use Benchee.Formatter which will already implement
the output/1 function for you. This is recommended as output/1
really shouldn’t have any more logic than that, logic/features should
be in either format/1 or write/1.
Link to this section Summary
Functions
Invokes format/1 and write/1 as defined by the Benchee.Formatter
behaviour. The output for all formatters are generated in parallel, and then
the results of that formatting are written in sequence
Callbacks
Takes the suite and returns whatever representation the formatter wants to use
to output that information. It is important that this function needs to be
pure (aka have no side effects) as benchee will run format/1 functions
of multiple formatters in parallel. The result will then be passed to
write/1
Combines format/1 and write/1 into a single convenience function that is
also chainable (as it takes a suite and returns a suite)
Takes the return value of format/1 and then performs some I/O for the user
to actually see the formatted data (UI, File IO, HTTP, …)
Link to this section Functions
parallel_output(Benchee.Suite.t(), [module()]) :: Benchee.Suite.t()
Invokes format/1 and write/1 as defined by the Benchee.Formatter
behaviour. The output for all formatters are generated in parallel, and then
the results of that formatting are written in sequence.
Link to this section Callbacks
Takes the suite and returns whatever representation the formatter wants to use
to output that information. It is important that this function needs to be
pure (aka have no side effects) as benchee will run format/1 functions
of multiple formatters in parallel. The result will then be passed to
write/1.
Combines format/1 and write/1 into a single convenience function that is
also chainable (as it takes a suite and returns a suite).
Takes the return value of format/1 and then performs some I/O for the user
to actually see the formatted data (UI, File IO, HTTP, …)