Runner<P, L, R> class abstract base

An abstract use case for executing tasks asynchronously via a cubit which accepts a P parameter and emits either an L failed value or an R success value.

Inheritance

• Object
• BlocBase<RunnerState>
• Cubit<RunnerState>
• DistinctCubit<RunnerState>
• Runner

Mixed in types

• BaseUseCase<P, L, R>

Constructors

Runner()

An abstract use case for executing tasks asynchronously via a cubit which accepts a P parameter and emits either an L failed value or an R success value.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

isClosed → bool

Whether the bloc is closed.

no setter, inherited

leftParams → P?

The last params used to execute the use case when it failed.

no setter, inherited

leftValue → L?

The last error value emitted by calling run.

no setter, override

params → Either<P, P>?

The last params used to execute the use case.

no setter, inherited

rightParams → P?

The last params used to execute the use case when it succeeded.

no setter, inherited

rightValue → R?

The last success value emitted by calling run.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state → RunnerState

The current state.

no setter, inherited

stream → Stream<RunnerState>

The current stream of states.

no setter, inherited

value → Either<L, R>?

The latest value emitted by calling run which can either reference the leftValue or the rightValue.

no setter, override

Methods

addError(Object error, [StackTrace? stackTrace]) → void

Reports an error which triggers onError with an optional StackTrace.

inherited

close() → Future<void>

Closes the instance. This method should be called when the instance is no longer needed. Once close is called, the instance can no longer be used.

inherited

distinctEmit(int actionToken, RunnerState stateCallback()) → RunnerState?

Updates the Cubit's state based on the stateCallback.

inherited

emit(RunnerState state) → void

Do not use directly. Instead, use distinctEmit.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onCall(P params) → FutureOr<Either<L, R>>

The use case action callback.

inherited

onChange(Change<RunnerState> change) → void

Called whenever a change occurs with the given change. A change occurs when a new state is emitted. onChange is called before the state of the cubit is updated. onChange is a great spot to add logging/analytics for a specific cubit.

inherited

onError(Object error, StackTrace stackTrace) → void

Called whenever an error occurs and notifies BlocObserver.onError.

inherited

requestNewActionToken() → int

Generates a new action token.

inherited

reset() → Future<void>

Clears all the data then emits a RunnerInitial.

override

run({required P params}) → Future<Either<L, R>?>

Executes the onCall use case action.

setParamsAndValue(P params, Either<L, R> value) → void

Sets the params and value of the use case.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited