Class MarkdownBenchmarkOutput

IBenchmarkOutput implementation that writes output for each completed benchmark to a markdown file. Uses FileNameGenerator to generate a file name unique to each test AND the time it was run.

Inheritance
System.Object
MarkdownBenchmarkOutput
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NBench.Reporting.Targets
Assembly: NBench.dll
Syntax
public class MarkdownBenchmarkOutput : IBenchmarkOutput

Constructors

MarkdownBenchmarkOutput(String)

Declaration
public MarkdownBenchmarkOutput(string outputDirectory)
Parameters
Type Name Description
System.String outputDirectory

Fields

MarkdownFileExtension

Declaration
public const string MarkdownFileExtension = ".md"
Field Value
Type Description
System.String

MarkdownTableColumnEnd

Declaration
public const string MarkdownTableColumnEnd = " |"
Field Value
Type Description
System.String

MarkdownTableColumnStart

Declaration
public const string MarkdownTableColumnStart = "|"
Field Value
Type Description
System.String

MaxColumnSize

Declaration
public const int MaxColumnSize = 18
Field Value
Type Description
System.Int32

Methods

Error(Exception, String)

Declaration
public void Error(Exception ex, string message)
Parameters
Type Name Description
System.Exception ex
System.String message

Error(String)

Declaration
public void Error(string message)
Parameters
Type Name Description
System.String message

FinishBenchmark(String)

Declaration
public void FinishBenchmark(string benchmarkName)
Parameters
Type Name Description
System.String benchmarkName

SkipBenchmark(String)

Declaration
public void SkipBenchmark(string benchmarkName)
Parameters
Type Name Description
System.String benchmarkName

StartBenchmark(String)

Declaration
public void StartBenchmark(string benchmarkName)
Parameters
Type Name Description
System.String benchmarkName

Warning(String)

Declaration
public void Warning(string message)
Parameters
Type Name Description
System.String message

WriteBenchmark(BenchmarkFinalResults)

Declaration
public void WriteBenchmark(BenchmarkFinalResults results)
Parameters
Type Name Description
BenchmarkFinalResults results

WriteLine(String)

Declaration
public void WriteLine(string message)
Parameters
Type Name Description
System.String message

WriteRun(BenchmarkRunReport, Boolean)

Declaration
public void WriteRun(BenchmarkRunReport report, bool isWarmup = false)
Parameters
Type Name Description
BenchmarkRunReport report
System.Boolean isWarmup

Implements