Wrecker.Runner

Documentation

newStandaloneRecorder :: IO (NextRef AllStats, Thread, Recorder)

Typically wrecker will control benchmarking actions. Howeve,r in some situations a benchmark might require more control.

To facilitate more complex scenarios wrecker provide newStandaloneRecorder which provides a Recorder and Thread that processes the events, and a reference to the current stats.

sinkRecorder :: Logger -> Recorder -> IO (NextRef AllStats, Thread)

updateSampler :: NextRef AllStats -> Event -> IO AllStats

collectEvent :: Logger -> NextRef AllStats -> Recorder -> IO ()

runAction :: Logger -> Int -> Int -> RunType -> (Recorder -> IO ()) -> Recorder -> IO ()

runWithNextVar :: Options -> (NextRef AllStats -> IO ()) -> (NextRef AllStats -> IO ()) -> (Recorder -> IO ()) -> IO AllStats

printLastSamples :: Options -> NextRef AllStats -> IO ()

runNonInteractive :: Options -> (Recorder -> IO ()) -> IO AllStats

printLoop :: Options -> DisplayContext -> Vty -> NextRef AllStats -> IO ()

processInputForCtrlC :: TChan Event -> IO ThreadId

updateUI :: Maybe Int -> DisplayContext -> AllStats -> IO ()

runInteractive :: Options -> (Recorder -> IO ()) -> IO AllStats

run :: Options -> [(String, Recorder -> IO ())] -> IO (HashMap String AllStats)

run is the a lower level entry point, compared to defaultMain. Unlike defaultMain no command line argument parsing is performed. Instead, Options are directly passed in. defaultOptions can be used as a default argument for run.

Like defaultMain, run creates a Recorder and passes it each benchmark.