BenchmarkRunMode enum

Which Dart/Flutter compilation mode a benchmark ran under.

The three modes are not equally trustworthy. debug runs the JIT with assertions and every framework debug check switched on -- often several times slower than what a real device shows a user, so a number captured in it is not a performance claim, it is a debug-mode number. profile keeps tracing on while running compiled, optimised code, which is why it is the mode this harness expects to run in. release is what ships, but strips the very tracing this harness reads, so a report from it exists only to confirm the app still builds and runs release, not to gate a budget against.

Inheritance
Available extensions

Values

debug → const BenchmarkRunMode

JIT, assertions on, framework debug checks on. Never a performance claim.

profile → const BenchmarkRunMode

Compiled, optimised, tracing left on. What this harness is meant to measure in.

release → const BenchmarkRunMode

Fully compiled, tracing stripped. Numbers observed here did not come from this harness's own instrumentation.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
isTrustworthy → bool
Whether a number captured in this mode may be presented as a performance claim.
no setter
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
warningBanner → String
A loud, single-line warning for a report captured in debug mode.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

current() → BenchmarkRunMode
The mode this process is actually running in right now.

Constants

values → const List<BenchmarkRunMode>
A constant List of the values in this enum, in order of their declaration.