Class ImmutableConfig

Namespace

BenchmarkDotNet.Configs

Assembly

BenchmarkDotNet.dll

public sealed class ImmutableConfig : IConfig

Inheritance

object

ImmutableConfig

Implements

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"

public string ArtifactsPath { get; }

Property Value

string

BuildTimeout

the auto-generated project build timeout

public TimeSpan BuildTimeout { get; }

Property Value

TimeSpan

CategoryDiscoverer

public ICategoryDiscoverer CategoryDiscoverer { get; }

Property Value

ICategoryDiscoverer

ConfigAnalysisConclusion

Collect any errors or warnings when composing the configuration

public IReadOnlyList<Conclusion> ConfigAnalysisConclusion { get; }

Property Value

IReadOnlyList<Conclusion>

CultureInfo

public CultureInfo CultureInfo { get; }

Property Value

CultureInfo

Options

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

public ConfigOptions Options { get; }

Property Value

ConfigOptions

Orderer

public IOrderer Orderer { get; }

Property Value

IOrderer

SummaryStyle

public SummaryStyle SummaryStyle { get; }

Property Value

SummaryStyle

UnionRule

public ConfigUnionRule UnionRule { get; }

Property Value

ConfigUnionRule

Methods

GetAnalysers()

public IEnumerable<IAnalyser> GetAnalysers()

Returns

IEnumerable<IAnalyser>

GetColumnHidingRules()

public IEnumerable<IColumnHidingRule> GetColumnHidingRules()

Returns

IEnumerable<IColumnHidingRule>

GetColumnProviders()

public IEnumerable<IColumnProvider> GetColumnProviders()

Returns

IEnumerable<IColumnProvider>

GetCompositeAnalyser()

public IAnalyser GetCompositeAnalyser()

Returns

IAnalyser

GetCompositeDiagnoser()

public IDiagnoser GetCompositeDiagnoser()

Returns

IDiagnoser

GetCompositeDiagnoser(BenchmarkCase, RunMode)

public IDiagnoser? GetCompositeDiagnoser(BenchmarkCase benchmarkCase, RunMode runMode)

Parameters

benchmarkCase BenchmarkCase

runMode RunMode

Returns

IDiagnoser

GetCompositeExporter()

public IExporter GetCompositeExporter()

Returns

IExporter

GetCompositeLogger()

public ILogger GetCompositeLogger()

Returns

ILogger

GetCompositeValidator()

public IValidator GetCompositeValidator()

Returns

IValidator

GetDiagnosers()

public IEnumerable<IDiagnoser> GetDiagnosers()

Returns

IEnumerable<IDiagnoser>

GetEventProcessors()

public IEnumerable<EventProcessor> GetEventProcessors()

Returns

IEnumerable<EventProcessor>

GetExporters()

public IEnumerable<IExporter> GetExporters()

Returns

IEnumerable<IExporter>

GetFilters()

public IEnumerable<IFilter> GetFilters()

Returns

IEnumerable<IFilter>

GetHardwareCounters()

public IEnumerable<HardwareCounter> GetHardwareCounters()

Returns

IEnumerable<HardwareCounter>

GetJobs()

public IEnumerable<Job> GetJobs()

Returns

IEnumerable<Job>

GetLoggers()

public IEnumerable<ILogger> GetLoggers()

Returns

IEnumerable<ILogger>

GetLogicalGroupRules()

public IEnumerable<BenchmarkLogicalGroupRule> GetLogicalGroupRules()

Returns

IEnumerable<BenchmarkLogicalGroupRule>

GetValidators()

public IEnumerable<IValidator> GetValidators()

Returns

IEnumerable<IValidator>

HasExceptionDiagnoser()

public bool HasExceptionDiagnoser()

Returns

bool

HasExtraStatsDiagnoser()

public bool HasExtraStatsDiagnoser()

Returns

bool

HasMemoryDiagnoser()

public bool HasMemoryDiagnoser()

Returns

bool

HasThreadingDiagnoser()

public bool HasThreadingDiagnoser()

Returns

bool