ProgressStreamWidget<T extends Object> class

Shows a heading-only spinner while consuming a Stream.

Uses ScrollingSection.runSpinner; it does not call CommandLogger.progressStream.

stream may be omitted when the output context holds a Stream<T>.

Inheritance

Constructors

ProgressStreamWidget({required String initialMessage, Stream<T>? stream, String? successMessage, String? failedMessage, String toMessage(T)?, bool isSuccess(T)?, bool newParagraph = false})

Properties

failedMessage → String?
final
hashCode → int
The hash code for this object.
no setterinherited
initialMessage → String
final
isSuccess → bool Function(T)?
final
newParagraph → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stream → Stream<T>?
final
successMessage → String?
final
toMessage → String Function(T)?
final

Methods

build(OutputContext context) → OutputWidget
Builds this widget using the output context.
override
buildTree(OutputContext context) → WidgetNode
Builds the tree of widgets below this one. This is not usually to be overridden by subclasses.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
render({required CommandLogger logger}) → void
Renders this widget using the given IO facade.
inherited
renderAsync({required CommandLogger logger}) → Future<void>
Renders this widget, awaiting stream or other async output.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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