DefaultBenchmarkRunner class

The built-in BenchmarkRunner.

Implemented types

• BenchmarkRunner

Constructors

DefaultBenchmarkRunner({BenchmarkRunnerConfig config = const BenchmarkRunnerConfig(), List<MetricCollector>? collectors})

Creates a runner.

Properties

config → BenchmarkRunnerConfig

Runner-level configuration.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

dryRun(BenchmarkContract scenario, {Map<String, dynamic>? config}) → Future<BenchmarkDryRunResult>

Validates the scenario metadata and configuration without executing anything (FR-012).

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerMetricCollector(MetricCollector collector) → void

Registers an additional metric collector on a live runner.

run(List<BenchmarkContract> scenarios, {Map<String, dynamic>? globalConfig, int? concurrency, Duration? timeout}) → Future<BenchmarkSuiteResult>

Runs scenarios and aggregates their results into a suite report (FR-008). When concurrency is greater than 1 the scenarios are executed by a worker pool of that size. timeout overrides the per-scenario timeout for every scenario in the suite.

override

runSingle(BenchmarkContract scenario, {Map<String, dynamic>? config, Duration? timeout}) → Future<BenchmarkResult>

Runs a single scenario and returns its structured result.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited