Class ConfigExtensions

Inheritance

Object

ConfigExtensions

Namespace: BenchmarkDotNet.Configs

Assembly: BenchmarkDotNet.dll

Syntax

public static class ConfigExtensions

Methods

AddAnalyser(IConfig, IAnalyser[])

Declaration

public static ManualConfig AddAnalyser(this IConfig config, params IAnalyser[] analysers)

Parameters

Type	Name	Description
IConfig	config
IAnalyser[]	analysers

Returns

Type	Description
ManualConfig

AddColumn(IConfig, IColumn[])

Declaration

public static ManualConfig AddColumn(this IConfig config, params IColumn[] columns)

Parameters

Type	Name	Description
IConfig	config
IColumn[]	columns

Returns

Type	Description
ManualConfig

AddColumnProvider(IConfig, IColumnProvider[])

Declaration

public static ManualConfig AddColumnProvider(this IConfig config, params IColumnProvider[] columnProviders)

Parameters

Type	Name	Description
IConfig	config
IColumnProvider[]	columnProviders

Returns

Type	Description
ManualConfig

AddDiagnoser(IConfig, IDiagnoser[])

Declaration

public static ManualConfig AddDiagnoser(this IConfig config, params IDiagnoser[] diagnosers)

Parameters

Type	Name	Description
IConfig	config
IDiagnoser[]	diagnosers

Returns

Type	Description
ManualConfig

AddExporter(IConfig, IExporter[])

Declaration

public static ManualConfig AddExporter(this IConfig config, params IExporter[] exporters)

Parameters

Type	Name	Description
IConfig	config
IExporter[]	exporters

Returns

Type	Description
ManualConfig

AddFilter(IConfig, IFilter[])

Declaration

public static ManualConfig AddFilter(this IConfig config, params IFilter[] filters)

Parameters

Type	Name	Description
IConfig	config
IFilter[]	filters

Returns

Type	Description
ManualConfig

AddHardwareCounters(IConfig, HardwareCounter[])

Declaration

public static ManualConfig AddHardwareCounters(this IConfig config, params HardwareCounter[] counters)

Parameters

Type	Name	Description
IConfig	config
HardwareCounter[]	counters

Returns

Type	Description
ManualConfig

AddJob(IConfig, Job)

Declaration

public static ManualConfig AddJob(this IConfig config, Job job)

Parameters

Type	Name	Description
IConfig	config
Job	job

Returns

Type	Description
ManualConfig

AddLogger(IConfig, ILogger[])

Declaration

public static ManualConfig AddLogger(this IConfig config, params ILogger[] loggers)

Parameters

Type	Name	Description
IConfig	config
ILogger[]	loggers

Returns

Type	Description
ManualConfig

AddLogicalGroupRules(IConfig, BenchmarkLogicalGroupRule[])

Declaration

public static ManualConfig AddLogicalGroupRules(this IConfig config, params BenchmarkLogicalGroupRule[] rules)

Parameters

Type	Name	Description
IConfig	config
BenchmarkLogicalGroupRule[]	rules

Returns

Type	Description
ManualConfig

AddValidator(IConfig, IValidator[])

Declaration

public static ManualConfig AddValidator(this IConfig config, params IValidator[] validators)

Parameters

Type	Name	Description
IConfig	config
IValidator[]	validators

Returns

Type	Description
ManualConfig

CreateImmutableConfig(IConfig)

Declaration

public static ImmutableConfig CreateImmutableConfig(this IConfig config)

Parameters

Type	Name	Description
IConfig	config

Returns

Type	Description
ImmutableConfig

DontOverwriteResults(IConfig, Boolean)

determines if the exported result files should not be overwritten (be default they are overwritten)

Declaration

public static IConfig DontOverwriteResults(this IConfig config, bool value = true)

Parameters

Type	Name	Description
IConfig	config
Boolean	value

Returns

Type	Description
IConfig

KeepBenchmarkFiles(IConfig, Boolean)

determines if all auto-generated files should be kept or removed after running the benchmarks

Declaration

public static IConfig KeepBenchmarkFiles(this IConfig config, bool value = true)

Parameters

Type	Name	Description
IConfig	config
Boolean	value

Returns

Type	Description
IConfig

StopOnFirstError(IConfig, Boolean)

determines if benchmarking should be stopped after the first error (by default it's not)

Declaration

public static IConfig StopOnFirstError(this IConfig config, bool value = true)

Parameters

Type	Name	Description
IConfig	config
Boolean	value

Returns

Type	Description
IConfig

WithArtifactsPath(IConfig, String)

Declaration

public static ManualConfig WithArtifactsPath(this IConfig config, string artifactsPath)

Parameters

Type	Name	Description
IConfig	config
String	artifactsPath

Returns

Type	Description
ManualConfig

WithCultureInfo(IConfig, CultureInfo)

Declaration

public static ManualConfig WithCultureInfo(this IConfig config, CultureInfo cultureInfo)

Parameters

Type	Name	Description
IConfig	config
CultureInfo	cultureInfo

Returns

Type	Description
ManualConfig

WithOption(IConfig, ConfigOptions, Boolean)

sets given option to provided value

Declaration

public static ManualConfig WithOption(this IConfig config, ConfigOptions option, bool value)

Parameters

Type	Name	Description
IConfig	config
ConfigOptions	option
Boolean	value

Returns

Type	Description
ManualConfig

WithOptions(IConfig, ConfigOptions)

sets given options for the config

Declaration

public static ManualConfig WithOptions(this IConfig config, ConfigOptions options)

Parameters

Type	Name	Description
IConfig	config
ConfigOptions	options

Returns

Type	Description
ManualConfig

WithOrderer(IConfig, IOrderer)

Declaration

public static ManualConfig WithOrderer(this IConfig config, IOrderer orderer)

Parameters

Type	Name	Description
IConfig	config
IOrderer	orderer

Returns

Type	Description
ManualConfig

WithSummaryStyle(IConfig, SummaryStyle)

Declaration

public static ManualConfig WithSummaryStyle(this IConfig config, SummaryStyle summaryStyle)

Parameters

Type	Name	Description
IConfig	config
SummaryStyle	summaryStyle

Returns

Type	Description
ManualConfig

WithUnionRule(IConfig, ConfigUnionRule)

Declaration

public static ManualConfig WithUnionRule(this IConfig config, ConfigUnionRule unionRule)

Parameters

Type	Name	Description
IConfig	config
ConfigUnionRule	unionRule

Returns

Type	Description
ManualConfig