Class ManualConfig
- Namespace
- BenchmarkDotNet.Configs
- Assembly
- BenchmarkDotNet.dll
public class ManualConfig : IConfig- Inheritance
-
ManualConfig
- Implements
- Extension Methods
Constructors
ManualConfig()
public ManualConfig()Properties
ArtifactsPath
the default value is "./BenchmarkDotNet.Artifacts"
public string ArtifactsPath { get; set; }Property Value
BuildTimeout
the auto-generated project build timeout
public TimeSpan BuildTimeout { get; set; }Property Value
CategoryDiscoverer
public ICategoryDiscoverer CategoryDiscoverer { get; set; }Property Value
ConfigAnalysisConclusion
Collect any errors or warnings when composing the configuration
public IReadOnlyList<Conclusion> ConfigAnalysisConclusion { get; }Property Value
CultureInfo
public CultureInfo CultureInfo { get; set; }Property Value
Options
a set of custom flags that can enable/disable various settings
public ConfigOptions Options { get; set; }Property Value
Orderer
public IOrderer Orderer { get; set; }Property Value
SummaryStyle
public SummaryStyle SummaryStyle { get; set; }Property Value
UnionRule
public ConfigUnionRule UnionRule { get; set; }Property Value
Methods
Add(IConfig)
public void Add(IConfig config)Parameters
configIConfig
AddAnalyser(params IAnalyser[])
public ManualConfig AddAnalyser(params IAnalyser[] newAnalysers)Parameters
newAnalysersIAnalyser[]
Returns
AddColumn(params IColumn[])
public ManualConfig AddColumn(params IColumn[] newColumns)Parameters
newColumnsIColumn[]
Returns
AddColumnProvider(params IColumnProvider[])
public ManualConfig AddColumnProvider(params IColumnProvider[] newColumnProviders)Parameters
newColumnProvidersIColumnProvider[]
Returns
AddDiagnoser(params IDiagnoser[])
public ManualConfig AddDiagnoser(params IDiagnoser[] newDiagnosers)Parameters
newDiagnosersIDiagnoser[]
Returns
AddEventProcessor(params EventProcessor[])
public ManualConfig AddEventProcessor(params EventProcessor[] newEventProcessors)Parameters
newEventProcessorsEventProcessor[]
Returns
AddExporter(params IExporter[])
public ManualConfig AddExporter(params IExporter[] newExporters)Parameters
newExportersIExporter[]
Returns
AddFilter(params IFilter[])
public ManualConfig AddFilter(params IFilter[] newFilters)Parameters
newFiltersIFilter[]
Returns
AddHardwareCounters(params HardwareCounter[])
public ManualConfig AddHardwareCounters(params HardwareCounter[] newHardwareCounters)Parameters
newHardwareCountersHardwareCounter[]
Returns
AddJob(params Job[])
public ManualConfig AddJob(params Job[] newJobs)Parameters
newJobsJob[]
Returns
AddLogger(params ILogger[])
public ManualConfig AddLogger(params ILogger[] newLoggers)Parameters
newLoggersILogger[]
Returns
AddLogicalGroupRules(params BenchmarkLogicalGroupRule[])
public ManualConfig AddLogicalGroupRules(params BenchmarkLogicalGroupRule[] rules)Parameters
rulesBenchmarkLogicalGroupRule[]
Returns
AddValidator(params IValidator[])
public ManualConfig AddValidator(params IValidator[] newValidators)Parameters
newValidatorsIValidator[]
Returns
Create(IConfig)
public static ManualConfig Create(IConfig config)Parameters
configIConfig
Returns
CreateEmpty()
Creates a completely EMPTY config with no predefined settings.
public static ManualConfig CreateEmpty()Returns
Remarks
You should most probably use the CreateMinimumViable() method instead.
CreateMinimumViable()
Creates a minimum viable config with predefined columns provider and console logger.
public static ManualConfig CreateMinimumViable()Returns
GetAnalysers()
public IEnumerable<IAnalyser> GetAnalysers()Returns
GetColumnHidingRules()
public IEnumerable<IColumnHidingRule> GetColumnHidingRules()Returns
GetColumnProviders()
public IEnumerable<IColumnProvider> GetColumnProviders()Returns
GetDiagnosers()
public IEnumerable<IDiagnoser> GetDiagnosers()Returns
GetEventProcessors()
public IEnumerable<EventProcessor> GetEventProcessors()Returns
GetExporters()
public IEnumerable<IExporter> GetExporters()Returns
GetFilters()
public IEnumerable<IFilter> GetFilters()Returns
GetHardwareCounters()
public IEnumerable<HardwareCounter> GetHardwareCounters()Returns
GetJobs()
public IEnumerable<Job> GetJobs()Returns
GetLoggers()
public IEnumerable<ILogger> GetLoggers()Returns
GetLogicalGroupRules()
public IEnumerable<BenchmarkLogicalGroupRule> GetLogicalGroupRules()Returns
GetValidators()
public IEnumerable<IValidator> GetValidators()Returns
HideColumns(params IColumnHidingRule[])
public ManualConfig HideColumns(params IColumnHidingRule[] rules)Parameters
rulesIColumnHidingRule[]
Returns
HideColumns(params IColumn[])
public ManualConfig HideColumns(params IColumn[] columns)Parameters
columnsIColumn[]
Returns
HideColumns(params string[])
public ManualConfig HideColumns(params string[] columnNames)Parameters
columnNamesstring[]
Returns
Union(IConfig, IConfig)
public static ManualConfig Union(IConfig globalConfig, IConfig localConfig)Parameters
Returns
WithArtifactsPath(string)
public ManualConfig WithArtifactsPath(string artifactsPath)Parameters
artifactsPathstring
Returns
WithBuildTimeout(TimeSpan)
public ManualConfig WithBuildTimeout(TimeSpan buildTimeout)Parameters
buildTimeoutTimeSpan
Returns
WithCategoryDiscoverer(ICategoryDiscoverer)
public ManualConfig WithCategoryDiscoverer(ICategoryDiscoverer categoryDiscoverer)Parameters
categoryDiscovererICategoryDiscoverer
Returns
WithOption(ConfigOptions, bool)
public ManualConfig WithOption(ConfigOptions option, bool value)Parameters
optionConfigOptionsvaluebool
Returns
WithOptions(ConfigOptions)
public ManualConfig WithOptions(ConfigOptions options)Parameters
optionsConfigOptions
Returns
WithOrderer(IOrderer)
public ManualConfig WithOrderer(IOrderer orderer)Parameters
ordererIOrderer
Returns
WithSummaryStyle(SummaryStyle)
public ManualConfig WithSummaryStyle(SummaryStyle summaryStyle)Parameters
summaryStyleSummaryStyle
Returns
WithUnionRule(ConfigUnionRule)
public ManualConfig WithUnionRule(ConfigUnionRule unionRule)Parameters
unionRuleConfigUnionRule