Interface IOrderer

Namespace

BenchmarkDotNet.Order

Assembly

BenchmarkDotNet.dll

public interface IOrderer

Properties

SeparateLogicalGroups

bool SeparateLogicalGroups { get; }

Property Value

bool

Methods

GetExecutionOrder(ImmutableArray<BenchmarkCase>, IEnumerable<BenchmarkLogicalGroupRule>?)

IEnumerable<BenchmarkCase> GetExecutionOrder(ImmutableArray<BenchmarkCase> benchmarksCase, IEnumerable<BenchmarkLogicalGroupRule>? order = null)

Parameters

benchmarksCase ImmutableArray<BenchmarkCase>

order IEnumerable<BenchmarkLogicalGroupRule>

Returns

IEnumerable<BenchmarkCase>

GetHighlightGroupKey(BenchmarkCase)

string? GetHighlightGroupKey(BenchmarkCase benchmarkCase)

Parameters

benchmarkCase BenchmarkCase

Returns

string

GetLogicalGroupKey(ImmutableArray<BenchmarkCase>, BenchmarkCase)

string? GetLogicalGroupKey(ImmutableArray<BenchmarkCase> allBenchmarksCases, BenchmarkCase benchmarkCase)

Parameters

allBenchmarksCases ImmutableArray<BenchmarkCase>

benchmarkCase BenchmarkCase

Returns

string

GetLogicalGroupOrder(IEnumerable<IGrouping<string, BenchmarkCase>>, IEnumerable<BenchmarkLogicalGroupRule>?)

IEnumerable<IGrouping<string, BenchmarkCase>> GetLogicalGroupOrder(IEnumerable<IGrouping<string, BenchmarkCase>> logicalGroups, IEnumerable<BenchmarkLogicalGroupRule>? order = null)

Parameters

logicalGroups IEnumerable<IGrouping<string, BenchmarkCase>>

order IEnumerable<BenchmarkLogicalGroupRule>

Returns

IEnumerable<IGrouping<string, BenchmarkCase>>

GetSummaryOrder(ImmutableArray<BenchmarkCase>, Summary)

IEnumerable<BenchmarkCase> GetSummaryOrder(ImmutableArray<BenchmarkCase> benchmarksCases, Summary summary)

Parameters

benchmarksCases ImmutableArray<BenchmarkCase>

summary Summary

Returns

IEnumerable<BenchmarkCase>