Benchee.Formatters.TaggedSave (Benchee v1.5.0)

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 later loading the results of previous runs with Benchee.ScenarioLoader.

Automatically configured as the last formatter to run when specifying the save option in the configuration - see Benchee.Configuration.

Summary

Functions

format(suite, formatter_config)

Tags all scenario with the desired tag and returns it in term_to_binary along with save path.

write(arg, _)

Writes the binary returned by format/2 to the indicated location, telling you where that is.

Functions

format(suite, formatter_config)

@spec format(Benchee.Suite.t(), map()) :: {binary(), String.t()}

Tags all scenario with the desired tag and returns it in term_to_binary along with save path.

write(arg, _)

@spec write(
  {binary(), String.t()},
  map()
) :: :ok

Writes the binary returned by format/2 to the indicated location, telling you where that is.