BuildBox.Build.Benchmark

Documentation

data Benchmark result

Benchmark definition.

Constructors

Benchmark

Fields

• benchmarkName :: String

  A unique name for the benchmark

• benchmarkSetup :: Build ()

  Setup command to run before the main benchmark. This does not contribute to the reported time of the overall result.

• benchmarkCommand :: Build a

  The main command to benchmark.

• benchmarkCheck :: a -> Build result

  Check and post-process the result of the main command. This does not contribute to the reported time of the overall result.

data BenchResult result

Benchmark result.

Constructors

BenchResult

Fields

• benchResultName :: String
• benchResultIteration :: Int
• benchResultTime :: Seconds
• benchResultValue :: result

runBenchmark :: Benchmark result -> Int -> Build (BenchResult result)

Run a benchmark a single time.

iterateBenchmark :: Int -> Benchmark result -> Build [BenchResult result]

Run a benchmark the given number of times.

timeBuild :: Build a -> Build (Seconds, a)

Run a command, returning its elapsed time.