Interface IConfig

Namespace: BenchmarkDotNet.Configs
Assembly: BenchmarkDotNet.dll
Syntax
public interface IConfig

Properties

ArtifactsPath

the default value is "./BenchmarkDotNet.Artifacts"

Declaration
string ArtifactsPath { get; }
Property Value
Type Description
String

BuildTimeout

the auto-generated project build timeout

Declaration
TimeSpan BuildTimeout { get; }
Property Value
Type Description
TimeSpan

ConfigAnalysisConclusion

Collect any errors or warnings when composing the configuration

Declaration
IReadOnlyList<Conclusion> ConfigAnalysisConclusion { get; }
Property Value
Type Description
IReadOnlyList<Conclusion>

CultureInfo

Declaration
CultureInfo CultureInfo { get; }
Property Value
Type Description
CultureInfo

Options

a set of custom flags that can enable/disable various settings

Declaration
ConfigOptions Options { get; }
Property Value
Type Description
ConfigOptions

Orderer

Declaration
IOrderer Orderer { get; }
Property Value
Type Description
IOrderer

SummaryStyle

Declaration
SummaryStyle SummaryStyle { get; }
Property Value
Type Description
SummaryStyle

UnionRule

Declaration
ConfigUnionRule UnionRule { get; }
Property Value
Type Description
ConfigUnionRule

Methods

GetAnalysers()

Declaration
IEnumerable<IAnalyser> GetAnalysers()
Returns
Type Description
IEnumerable<IAnalyser>

GetColumnProviders()

Declaration
IEnumerable<IColumnProvider> GetColumnProviders()
Returns
Type Description
IEnumerable<IColumnProvider>

GetDiagnosers()

Declaration
IEnumerable<IDiagnoser> GetDiagnosers()
Returns
Type Description
IEnumerable<IDiagnoser>

GetExporters()

Declaration
IEnumerable<IExporter> GetExporters()
Returns
Type Description
IEnumerable<IExporter>

GetFilters()

Declaration
IEnumerable<IFilter> GetFilters()
Returns
Type Description
IEnumerable<IFilter>

GetHardwareCounters()

Declaration
IEnumerable<HardwareCounter> GetHardwareCounters()
Returns
Type Description
IEnumerable<HardwareCounter>

GetJobs()

Declaration
IEnumerable<Job> GetJobs()
Returns
Type Description
IEnumerable<Job>

GetLoggers()

Declaration
IEnumerable<ILogger> GetLoggers()
Returns
Type Description
IEnumerable<ILogger>

GetLogicalGroupRules()

Declaration
IEnumerable<BenchmarkLogicalGroupRule> GetLogicalGroupRules()
Returns
Type Description
IEnumerable<BenchmarkLogicalGroupRule>

GetValidators()

Declaration
IEnumerable<IValidator> GetValidators()
Returns
Type Description
IEnumerable<IValidator>

Extension Methods