Benchee v0.13.0 Benchee.Formatters.TaggedSave View Source

Store the whole suite in the Erlang ExternalTermFormat while tagging the scenarios of the current run with a specified tag - can be used for storing and loading the results of previous runs.

Automatically invoked and appended when specifiying the save option in the configuration.

Link to this section Summary

Functions

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

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.

Callback implementation for Benchee.Formatter.format/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, …)

Callback implementation for Benchee.Formatter.write/1.