VerboseStep<Input, Output> mixin

Mixin that adds logging and execution control capabilities to steps.

Key features:

  • Custom step descriptions
  • Progress messages
  • Retry configuration
  • Timeout control

Example:

class ApiStep extends ChainStep<Request, Response>
    with VerboseStep<Request, Response> {

  @override
  String get description => 'Calls external API';

  @override
  bool get shouldRetry => true;

  @override
  int get maxRetries => 3;
}
Superclass constraints

Properties

completeMessage String
Message to show when step completes
no setter
description String
Description of what this step does
no setter
errorMessage String
Message to show when step fails
no setter
hashCode int
The hash code for this object.
no setterinherited
initMessage String
Message to show when step starts
no setter
inputType Type
Type of input data this step accepts
no setterinherited
maxRetries int
Maximum number of retries
no setter
outputType Type
Type of output data this step produces
no setterinherited
retryDelay Duration
Delay between retries
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shouldRetry bool
Whether to retry on failure
no setter
stepName String
Name of the step (defaults to class name)
no setter
timeout Duration?
Optional timeout for this specific step
no setter

Methods

handle(Input data, ChainContext context) FutureOr<Output>
Handles the input data and produces output
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rollback(Input data, ChainContext context) FutureOr<void>
Optional rollback logic for the step
inherited
toString() String
A string representation of this object.
inherited

Operators

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