require 'benchmark_driver/struct'

# All benchmark results should be expressed by this model.
module BenchmarkDriver
  Metrics = ::BenchmarkDriver::Struct.new(
    :value,      # @param [Float] - The main field of benchmark result
    :executable, # @param [BenchmarkDriver::Config::Executable] - Measured Ruby executable
    :duration,   # @param [Float,nil] - Time taken to run the script (optional)
  )

  Metrics::Type = ::BenchmarkDriver::Struct.new(
    :unit,          # @param [String] - A label of unit for the value.
    :larger_better, # @param [TrueClass,FalseClass] - If true, larger value is preferred when measured multiple times.
    :worse_word,    # @param [String] - A label shown when the value is worse.
    defaults: { larger_better: true, worse_word: 'slower' },
  )
end