Bubble class abstract

A Bubble is a Step that consists of running a builder function, and its returned Step, until it receives the prompt to stop. Then it will run the candidate it got on the execution of itself.

A Bubble can be closed by FlowContext.pop(), FlowContext.close() or by setting the bool leave to true.

  • pop() and close() are meant for errors that can occur as part of the workflow inside of the Bubble.
  • leave is way to escape the Bubble successfully.

As example, in the Chain step, leave is set to true whenever the length of the steps is reached.

Inheritance
Implementers
Annotations
  • @Deprecated("Move over to FlowController.createBubble")

Constructors

Bubble()

Properties

hashCode → int
The hash code for this object.
no setterinherited
leave ↔ bool
Marks if the Bubble should be closed after the current running Step.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

builder() → Step
The builder function will be called whenever the previous step inside the Bubble passes by without an error.
execute(FlowController controller, [FutureOr<Step?> candidate()?]) → FutureOr<Step?>
Executes the builder function until an escape prompt is received.
override
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