Struct BenchmarkRunReport

Compiled statistics for each BenchmarkRun

Inherited Members

System.ValueType.Equals(System.Object)

System.ValueType.GetHashCode()

System.ValueType.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: NBench.Reporting

Assembly: NBench.dll

Syntax

public struct BenchmarkRunReport

Constructors

BenchmarkRunReport(TimeSpan, IDictionary<MetricName, MetricRunReport>, IReadOnlyList<Exception>)

Declaration

public BenchmarkRunReport(TimeSpan elapsed, IDictionary<MetricName, MetricRunReport> metrics, IReadOnlyList<Exception> exceptions)

Parameters

Type	Name	Description
System.TimeSpan	elapsed
System.Collections.Generic.IDictionary<MetricName, MetricRunReport>	metrics
System.Collections.Generic.IReadOnlyList<System.Exception>	exceptions

BenchmarkRunReport(TimeSpan, IEnumerable<MetricRunReport>, IReadOnlyList<Exception>)

Declaration

public BenchmarkRunReport(TimeSpan elapsed, IEnumerable<MetricRunReport> metrics, IReadOnlyList<Exception> exceptions)

Parameters

Type	Name	Description
System.TimeSpan	elapsed
System.Collections.Generic.IEnumerable<MetricRunReport>	metrics
System.Collections.Generic.IReadOnlyList<System.Exception>	exceptions

Properties

Elapsed

Total amount of elapsed time on this run

Declaration

public TimeSpan Elapsed { get; }

Property Value

Type	Description
System.TimeSpan

Exceptions

The set of System.Exceptions that may have occurred during a benchmark.

Declaration

public IReadOnlyList<Exception> Exceptions { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<System.Exception>

IsFaulted

Returns true if any System.Exceptions were thrown during this run.

Declaration

public bool IsFaulted { get; }

Property Value

Type	Description
System.Boolean

Metrics

Key value pair of all metrics, where the key corresponds to the name of the metric

Declaration

public IDictionary<MetricName, MetricRunReport> Metrics { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<MetricName, MetricRunReport>