Class ConfigExtensions

Namespace

BenchmarkDotNet.Configs

Assembly

BenchmarkDotNet.dll

public static class ConfigExtensions

Inheritance

object

ConfigExtensions

Methods

AddAnalyser(IConfig, params IAnalyser[])

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

Parameters

config IConfig

analysers IAnalyser[]

Returns

ManualConfig

AddColumn(IConfig, params IColumn[])

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

Parameters

config IConfig

columns IColumn[]

Returns

ManualConfig

AddColumnProvider(IConfig, params IColumnProvider[])

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

Parameters

config IConfig

columnProviders IColumnProvider[]

Returns

ManualConfig

AddDiagnoser(IConfig, params IDiagnoser[])

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

Parameters

config IConfig

diagnosers IDiagnoser[]

Returns

ManualConfig

AddEventProcessor(IConfig, params EventProcessor[])

public static ManualConfig AddEventProcessor(this IConfig config, params EventProcessor[] eventProcessors)

Parameters

config IConfig

eventProcessors EventProcessor[]

Returns

ManualConfig

AddExporter(IConfig, params IExporter[])

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

Parameters

config IConfig

exporters IExporter[]

Returns

ManualConfig

AddFilter(IConfig, params IFilter[])

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

Parameters

config IConfig

filters IFilter[]

Returns

ManualConfig

AddHardwareCounters(IConfig, params HardwareCounter[])

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

Parameters

config IConfig

counters HardwareCounter[]

Returns

ManualConfig

AddJob(IConfig, Job)

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

Parameters

config IConfig

job Job

Returns

ManualConfig

AddLogger(IConfig, params ILogger[])

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

Parameters

config IConfig

loggers ILogger[]

Returns

ManualConfig

AddLogicalGroupRules(IConfig, params BenchmarkLogicalGroupRule[])

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

Parameters

config IConfig

rules BenchmarkLogicalGroupRule[]

Returns

ManualConfig

AddValidator(IConfig, params IValidator[])

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

Parameters

config IConfig

validators IValidator[]

Returns

ManualConfig

CreateImmutableConfig(IConfig)

public static ImmutableConfig CreateImmutableConfig(this IConfig config)

Parameters

config IConfig

Returns

ImmutableConfig

DontOverwriteResults(IConfig, bool)

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

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

Parameters

config IConfig

value bool

Returns

IConfig

HideColumns(IConfig, params IColumnHidingRule[])

public static ManualConfig HideColumns(this IConfig config, params IColumnHidingRule[] rules)

Parameters

config IConfig

rules IColumnHidingRule[]

Returns

ManualConfig

HideColumns(IConfig, params IColumn[])

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

Parameters

config IConfig

columns IColumn[]

Returns

ManualConfig

HideColumns(IConfig, params string[])

public static ManualConfig HideColumns(this IConfig config, params string[] columnNames)

Parameters

config IConfig

columnNames string[]

Returns

ManualConfig

KeepBenchmarkFiles(IConfig, bool)

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

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

Parameters

config IConfig

value bool

Returns

IConfig

StopOnFirstError(IConfig, bool)

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

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

Parameters

config IConfig

value bool

Returns

IConfig

WithArtifactsPath(IConfig, string)

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

Parameters

config IConfig

artifactsPath string

Returns

ManualConfig

WithCultureInfo(IConfig, CultureInfo)

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

Parameters

config IConfig

cultureInfo CultureInfo

Returns

ManualConfig

WithOption(IConfig, ConfigOptions, bool)

sets given option to provided value

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

Parameters

config IConfig

option ConfigOptions

value bool

Returns

ManualConfig

WithOptions(IConfig, ConfigOptions)

sets given options for the config

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

Parameters

config IConfig

options ConfigOptions

Returns

ManualConfig

WithOrderer(IConfig, IOrderer)

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

Parameters

config IConfig

orderer IOrderer

Returns

ManualConfig

WithSummaryStyle(IConfig, SummaryStyle)

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

Parameters

config IConfig

summaryStyle SummaryStyle

Returns

ManualConfig

WithUnionRule(IConfig, ConfigUnionRule)

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

Parameters

config IConfig

unionRule ConfigUnionRule

Returns

ManualConfig