StateEmitter<S> class
A StateEmitter is similar to EventToStateProcessor but has no notion of events and relies on methods to emit new states.
Every StateEmitter requires an initial state which will be the state of the StateEmitter before emit has been called.
The current state of a StateEmitter can be accessed via the state getter.
class CounterStateEmitter extends StateEmitter<int> {
CounterCubit() : super(0);
void increment() => updateState(state + 1);
}
Constructors
- StateEmitter(S initialState)
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isClosed → bool
-
Whether the bloc is closed.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state → S
-
The current state.
no setterinherited
-
stream
→ Stream<
S> -
The current stream of states.
no setterinherited
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
-
emit(
S state) → void -
Updates the
state
to the providedstate
. emit does nothing if thestate
being emitted is equal to the currentstate
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onChange(
Change< S> change) → void -
Called whenever a
change
occurs with the givenchange
. Achange
occurs when a newstate
is emitted. onChange is called before thestate
of thecubit
is updated. onChange is a great spot to add logging/analytics for a specificcubit
.inherited -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
error
occurs and notifies BlocObserver.onError.inherited -
toString(
) → String -
A string representation of this object.
inherited
-
updateState(
S newState) → void - Send|Update state for UI
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited