Show / Hide Table of Contents

Class ManualConfig

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

Properties

ArtifactsPath

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

BuildTimeout

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

ConfigAnalysisConclusion

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

CultureInfo

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

Options

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

Orderer

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

SummaryStyle

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

UnionRule

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

Methods

Add(IConfig)

Declaration
public void Add(IConfig config)
Parameters
Type Name Description
IConfig config

AddAnalyser(IAnalyser[])

Declaration
public ManualConfig AddAnalyser(params IAnalyser[] newAnalysers)
Parameters
Type Name Description
IAnalyser[] newAnalysers
Returns
Type Description
ManualConfig

AddColumn(IColumn[])

Declaration
public ManualConfig AddColumn(params IColumn[] newColumns)
Parameters
Type Name Description
IColumn[] newColumns
Returns
Type Description
ManualConfig

AddColumnProvider(IColumnProvider[])

Declaration
public ManualConfig AddColumnProvider(params IColumnProvider[] newColumnProviders)
Parameters
Type Name Description
IColumnProvider[] newColumnProviders
Returns
Type Description
ManualConfig

AddDiagnoser(IDiagnoser[])

Declaration
public ManualConfig AddDiagnoser(params IDiagnoser[] newDiagnosers)
Parameters
Type Name Description
IDiagnoser[] newDiagnosers
Returns
Type Description
ManualConfig

AddExporter(IExporter[])

Declaration
public ManualConfig AddExporter(params IExporter[] newExporters)
Parameters
Type Name Description
IExporter[] newExporters
Returns
Type Description
ManualConfig

AddFilter(IFilter[])

Declaration
public ManualConfig AddFilter(params IFilter[] newFilters)
Parameters
Type Name Description
IFilter[] newFilters
Returns
Type Description
ManualConfig

AddHardwareCounters(HardwareCounter[])

Declaration
public ManualConfig AddHardwareCounters(params HardwareCounter[] newHardwareCounters)
Parameters
Type Name Description
HardwareCounter[] newHardwareCounters
Returns
Type Description
ManualConfig

AddJob(Job[])

Declaration
public ManualConfig AddJob(params Job[] newJobs)
Parameters
Type Name Description
Job[] newJobs
Returns
Type Description
ManualConfig

AddLogger(ILogger[])

Declaration
public ManualConfig AddLogger(params ILogger[] newLoggers)
Parameters
Type Name Description
ILogger[] newLoggers
Returns
Type Description
ManualConfig

AddLogicalGroupRules(BenchmarkLogicalGroupRule[])

Declaration
public ManualConfig AddLogicalGroupRules(params BenchmarkLogicalGroupRule[] rules)
Parameters
Type Name Description
BenchmarkLogicalGroupRule[] rules
Returns
Type Description
ManualConfig

AddValidator(IValidator[])

Declaration
public ManualConfig AddValidator(params IValidator[] newValidators)
Parameters
Type Name Description
IValidator[] newValidators
Returns
Type Description
ManualConfig

Create(IConfig)

Declaration
public static ManualConfig Create(IConfig config)
Parameters
Type Name Description
IConfig config
Returns
Type Description
ManualConfig

CreateEmpty()

Creates a completely EMPTY config with no predefined settings.

Declaration
public static ManualConfig CreateEmpty()
Returns
Type Description
ManualConfig
Remarks

You should most probably use the CreateMinimumViable() method instead.

CreateMinimumViable()

Creates a minimum viable config with predefined columns provider and console logger.

Declaration
public static ManualConfig CreateMinimumViable()
Returns
Type Description
ManualConfig

GetAnalysers()

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

GetColumnProviders()

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

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>

Union(IConfig, IConfig)

Declaration
public static ManualConfig Union(IConfig globalConfig, IConfig localConfig)
Parameters
Type Name Description
IConfig globalConfig
IConfig localConfig
Returns
Type Description
ManualConfig

WithArtifactsPath(String)

Declaration
public ManualConfig WithArtifactsPath(string artifactsPath)
Parameters
Type Name Description
String artifactsPath
Returns
Type Description
ManualConfig

WithBuildTimeout(TimeSpan)

Declaration
public ManualConfig WithBuildTimeout(TimeSpan buildTimeout)
Parameters
Type Name Description
TimeSpan buildTimeout
Returns
Type Description
ManualConfig

WithOption(ConfigOptions, Boolean)

Declaration
public ManualConfig WithOption(ConfigOptions option, bool value)
Parameters
Type Name Description
ConfigOptions option
Boolean value
Returns
Type Description
ManualConfig

WithOptions(ConfigOptions)

Declaration
public ManualConfig WithOptions(ConfigOptions options)
Parameters
Type Name Description
ConfigOptions options
Returns
Type Description
ManualConfig

WithOrderer(IOrderer)

Declaration
public ManualConfig WithOrderer(IOrderer orderer)
Parameters
Type Name Description
IOrderer orderer
Returns
Type Description
ManualConfig

WithSummaryStyle(SummaryStyle)

Declaration
public ManualConfig WithSummaryStyle(SummaryStyle summaryStyle)
Parameters
Type Name Description
SummaryStyle summaryStyle
Returns
Type Description
ManualConfig

WithUnionRule(ConfigUnionRule)

Declaration
public ManualConfig WithUnionRule(ConfigUnionRule unionRule)
Parameters
Type Name Description
ConfigUnionRule unionRule
Returns
Type Description
ManualConfig

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