PluginBudget class final

What a plugin promises to cost, read from its manifest's budget.

PluginManifest(
  id: 'wind',
  apiVersion: PluginApiVersion(1, 0),
  extra: {'budget': {'stepMicroseconds': 200, 'eventsPerStep': 8}},
)

In the manifest's open keys, because the manifest keeps what it does not know and a later minor of the plugin API may give the budget a field of its own without moving where a plugin wrote it.

Constructors

PluginBudget({Duration? stepLimit, int? eventsPerStep})

A budget with either limit left null when the plugin does not promise it.

const

Properties

eventsPerStep → int?

The most events the plugin's step may publish in any one step.

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

stepLimit → Duration?

The most the plugin may add to one step, measured as the median over several batches on the machine running the suite. The manifest writes it as whole microseconds, stepMicroseconds.

final

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

of(PluginManifest manifest) → PluginBudget?

The budget manifest declares, or null when it declares none or one that does not read — the manifest check says which, in a sentence.