Interface IConfig

Namespace

BenchmarkDotNet.Configs

Assembly

BenchmarkDotNet.dll

public interface IConfig

Extension Methods

ConfigExtensions.AddAnalyser(IConfig, params IAnalyser[])

ConfigExtensions.AddColumn(IConfig, params IColumn[])

ConfigExtensions.AddColumnProvider(IConfig, params IColumnProvider[])

ConfigExtensions.AddDiagnoser(IConfig, params IDiagnoser[])

ConfigExtensions.AddEventProcessor(IConfig, params EventProcessor[])

ConfigExtensions.AddExporter(IConfig, params IExporter[])

ConfigExtensions.AddFilter(IConfig, params IFilter[])

ConfigExtensions.AddHardwareCounters(IConfig, params HardwareCounter[])

ConfigExtensions.AddJob(IConfig, Job)

ConfigExtensions.AddLogger(IConfig, params ILogger[])

ConfigExtensions.AddLogicalGroupRules(IConfig, params BenchmarkLogicalGroupRule[])

ConfigExtensions.AddValidator(IConfig, params IValidator[])

ConfigExtensions.CreateImmutableConfig(IConfig)

ConfigExtensions.DontOverwriteResults(IConfig, bool)

ConfigExtensions.HideColumns(IConfig, params IColumn[])

ConfigExtensions.HideColumns(IConfig, params IColumnHidingRule[])

ConfigExtensions.HideColumns(IConfig, params string[])

ConfigExtensions.KeepBenchmarkFiles(IConfig, bool)

ConfigExtensions.StopOnFirstError(IConfig, bool)

ConfigExtensions.WithArtifactsPath(IConfig, string)

ConfigExtensions.WithCultureInfo(IConfig, CultureInfo)

ConfigExtensions.WithOption(IConfig, ConfigOptions, bool)

ConfigExtensions.WithOptions(IConfig, ConfigOptions)

ConfigExtensions.WithOrderer(IConfig, IOrderer)

ConfigExtensions.WithSummaryStyle(IConfig, SummaryStyle)

ConfigExtensions.WithUnionRule(IConfig, ConfigUnionRule)

Properties

ArtifactsPath

the default value is "./BenchmarkDotNet.Artifacts"

string ArtifactsPath { get; }

Property Value

string

BuildTimeout

the auto-generated project build timeout

TimeSpan BuildTimeout { get; }

Property Value

TimeSpan

CategoryDiscoverer

ICategoryDiscoverer? CategoryDiscoverer { get; }

Property Value

ICategoryDiscoverer

ConfigAnalysisConclusion

Collect any errors or warnings when composing the configuration

IReadOnlyList<Conclusion> ConfigAnalysisConclusion { get; }

Property Value

IReadOnlyList<Conclusion>

CultureInfo

CultureInfo? CultureInfo { get; }

Property Value

CultureInfo

Options

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

ConfigOptions Options { get; }

Property Value

ConfigOptions

Orderer

IOrderer? Orderer { get; }

Property Value

IOrderer

SummaryStyle

SummaryStyle SummaryStyle { get; }

Property Value

SummaryStyle

UnionRule

ConfigUnionRule UnionRule { get; }

Property Value

ConfigUnionRule

Methods

GetAnalysers()

IEnumerable<IAnalyser> GetAnalysers()

Returns

IEnumerable<IAnalyser>

GetColumnHidingRules()

IEnumerable<IColumnHidingRule> GetColumnHidingRules()

Returns

IEnumerable<IColumnHidingRule>

GetColumnProviders()

IEnumerable<IColumnProvider> GetColumnProviders()

Returns

IEnumerable<IColumnProvider>

GetDiagnosers()

IEnumerable<IDiagnoser> GetDiagnosers()

Returns

IEnumerable<IDiagnoser>

GetEventProcessors()

IEnumerable<EventProcessor> GetEventProcessors()

Returns

IEnumerable<EventProcessor>

GetExporters()

IEnumerable<IExporter> GetExporters()

Returns

IEnumerable<IExporter>

GetFilters()

IEnumerable<IFilter> GetFilters()

Returns

IEnumerable<IFilter>

GetHardwareCounters()

IEnumerable<HardwareCounter> GetHardwareCounters()

Returns

IEnumerable<HardwareCounter>

GetJobs()

IEnumerable<Job> GetJobs()

Returns

IEnumerable<Job>

GetLoggers()

IEnumerable<ILogger> GetLoggers()

Returns

IEnumerable<ILogger>

GetLogicalGroupRules()

IEnumerable<BenchmarkLogicalGroupRule> GetLogicalGroupRules()

Returns

IEnumerable<BenchmarkLogicalGroupRule>

GetValidators()

IEnumerable<IValidator> GetValidators()

Returns

IEnumerable<IValidator>