Class BenchmarkReport

Inheritance
Object
BenchmarkReport
Namespace: BenchmarkDotNet.Reports
Assembly: BenchmarkDotNet.dll
Syntax
public sealed class BenchmarkReport

Constructors

BenchmarkReport(Boolean, BenchmarkCase, GenerateResult, BuildResult, IReadOnlyList<ExecuteResult>, IReadOnlyList<Metric>)

Declaration
public BenchmarkReport(bool success, BenchmarkCase benchmarkCase, GenerateResult generateResult, BuildResult buildResult, IReadOnlyList<ExecuteResult> executeResults, IReadOnlyList<Metric> metrics)
Parameters
Type Name Description
Boolean success
BenchmarkCase benchmarkCase
GenerateResult generateResult
BuildResult buildResult
IReadOnlyList<ExecuteResult> executeResults
IReadOnlyList<Metric> metrics

Properties

AllMeasurements

Declaration
public IReadOnlyList<Measurement> AllMeasurements { get; }
Property Value
Type Description
IReadOnlyList<Measurement>

BenchmarkCase

Declaration
public BenchmarkCase BenchmarkCase { get; }
Property Value
Type Description
BenchmarkCase

BuildResult

Declaration
public BuildResult BuildResult { get; }
Property Value
Type Description
BuildResult

ExecuteResults

Declaration
public IReadOnlyList<ExecuteResult> ExecuteResults { get; }
Property Value
Type Description
IReadOnlyList<ExecuteResult>

GcStats

Declaration
public GcStats GcStats { get; }
Property Value
Type Description
GcStats

GenerateResult

Declaration
public GenerateResult GenerateResult { get; }
Property Value
Type Description
GenerateResult

Metrics

Declaration
public IReadOnlyDictionary<string, Metric> Metrics { get; }
Property Value
Type Description
IReadOnlyDictionary<String, Metric>

ResultStatistics

Declaration
public Statistics ResultStatistics { get; }
Property Value
Type Description
Statistics

Success

Declaration
public bool Success { get; }
Property Value
Type Description
Boolean

Methods

GetResultRuns()

Declaration
public IReadOnlyList<Measurement> GetResultRuns()
Returns
Type Description
IReadOnlyList<Measurement>

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Extension Methods