Interface IBenchmarkOutput
Interface used to write BenchmarkRunReport and BenchmarkResults out to various reporting mechansims, including file-based and console-based ones.
Namespace: NBench.Reporting
Assembly: NBench.dll
Syntax
public interface IBenchmarkOutputMethods
Error(Exception, String)
Write an error to the NBench output
Declaration
void Error(Exception ex, string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.Exception | ex | The System.Exception raised during the benchmark. |
| System.String | message | The message we're going to write to output. |
Error(String)
Write an error to the NBench output
Declaration
void Error(string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | message | The message we're going to write to output. |
FinishBenchmark(String)
Signals that we've completed processing a benchmark, regardless of how it finished.
Declaration
void FinishBenchmark(string benchmarkName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | benchmarkName | The name of the benchmark. |
SkipBenchmark(String)
Signal that we're going to be skipping a benchmark
Declaration
void SkipBenchmark(string benchmarkName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | benchmarkName | The name of the benchmark. |
StartBenchmark(String)
Signal that we're going to begin a new benchmark
Declaration
void StartBenchmark(string benchmarkName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | benchmarkName | The name of the benchmark. |
Warning(String)
Write a warning to the NBench output
Declaration
void Warning(string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | message | The message we're going to write to output. |
WriteBenchmark(BenchmarkFinalResults)
Write out the entire benchmark result set to the console or file
Declaration
void WriteBenchmark(BenchmarkFinalResults results)Parameters
| Type | Name | Description |
|---|---|---|
| BenchmarkFinalResults | results | The report for all BenchmarkRuns in a Benchmark, including Assertion results. |
WriteLine(String)
Write a line to the NBench output
Declaration
void WriteLine(string message)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | message | The message we're going to write to output. |
WriteRun(BenchmarkRunReport, Boolean)
Write out an individual run to the console or file
Declaration
void WriteRun(BenchmarkRunReport report, bool isWarmup = false)Parameters
| Type | Name | Description |
|---|---|---|
| BenchmarkRunReport | report | The report for an individual BenchmarkRun |
| System.Boolean | isWarmup | If |