Show / Hide Table of Contents

Class ImmutableConfig

Inheritance
Object
ImmutableConfig
Implements
IConfig
Namespace: BenchmarkDotNet.Configs
Assembly: BenchmarkDotNet.dll
Syntax
public sealed class ImmutableConfig : IConfig

Properties

ArtifactsPath

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

BuildTimeout

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

ConfigAnalysisConclusion

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

CultureInfo

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

Options

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

Orderer

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

SummaryStyle

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

UnionRule

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

Methods

GetAnalysers()

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

GetColumnProviders()

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

GetCompositeAnalyser()

Declaration
public IAnalyser GetCompositeAnalyser()
Returns
Type Description
IAnalyser

GetCompositeDiagnoser()

Declaration
public IDiagnoser GetCompositeDiagnoser()
Returns
Type Description
IDiagnoser

GetCompositeDiagnoser(BenchmarkCase, RunMode)

Declaration
public IDiagnoser GetCompositeDiagnoser(BenchmarkCase benchmarkCase, RunMode runMode)
Parameters
Type Name Description
BenchmarkCase benchmarkCase
RunMode runMode
Returns
Type Description
IDiagnoser

GetCompositeExporter()

Declaration
public IExporter GetCompositeExporter()
Returns
Type Description
IExporter

GetCompositeLogger()

Declaration
public ILogger GetCompositeLogger()
Returns
Type Description
ILogger

GetCompositeValidator()

Declaration
public IValidator GetCompositeValidator()
Returns
Type Description
IValidator

GetDiagnosers()

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

GetExporters()

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

GetFilters()

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

GetHardwareCounters()

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

GetJobs()

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

GetLoggers()

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

GetLogicalGroupRules()

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

GetValidators()

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

HasExtraStatsDiagnoser()

Declaration
public bool HasExtraStatsDiagnoser()
Returns
Type Description
Boolean

HasMemoryDiagnoser()

Declaration
public bool HasMemoryDiagnoser()
Returns
Type Description
Boolean

HasThreadingDiagnoser()

Declaration
public bool HasThreadingDiagnoser()
Returns
Type Description
Boolean

Implements

IConfig

Extension Methods

ConfigExtensions.AddColumn(IConfig, IColumn[])
ConfigExtensions.AddColumnProvider(IConfig, IColumnProvider[])
ConfigExtensions.AddLogger(IConfig, ILogger[])
ConfigExtensions.AddExporter(IConfig, IExporter[])
ConfigExtensions.AddDiagnoser(IConfig, IDiagnoser[])
ConfigExtensions.AddAnalyser(IConfig, IAnalyser[])
ConfigExtensions.AddValidator(IConfig, IValidator[])
ConfigExtensions.AddJob(IConfig, Job)
ConfigExtensions.WithOrderer(IConfig, IOrderer)
ConfigExtensions.AddHardwareCounters(IConfig, HardwareCounter[])
ConfigExtensions.AddFilter(IConfig, IFilter[])
ConfigExtensions.WithSummaryStyle(IConfig, SummaryStyle)
ConfigExtensions.WithArtifactsPath(IConfig, String)
ConfigExtensions.WithUnionRule(IConfig, ConfigUnionRule)
ConfigExtensions.WithCultureInfo(IConfig, CultureInfo)
ConfigExtensions.KeepBenchmarkFiles(IConfig, Boolean)
ConfigExtensions.DontOverwriteResults(IConfig, Boolean)
ConfigExtensions.StopOnFirstError(IConfig, Boolean)
ConfigExtensions.WithOption(IConfig, ConfigOptions, Boolean)
ConfigExtensions.WithOptions(IConfig, ConfigOptions)
ConfigExtensions.AddLogicalGroupRules(IConfig, BenchmarkLogicalGroupRule[])
ConfigExtensions.CreateImmutableConfig(IConfig)
In This Article
Back to top Copyright © 2013–2021 .NET Foundation and contributors