NeatState<S> class
NeatState is just cubit with global state of your app initialState - Initial state
Constructors
-
NeatState({required S initialState, void onChangeCallback(Change<
S> change)?})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isClosed → bool
-
Whether the bloc is closed.
no setterinherited
-
onChangeCallback
→ (void Function(Change<
S> change)?) -
final
- 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 state stream.
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 the instance has been closed or if thestate
being emitted is equal to the currentstate
.inherited -
listen(
void onData(S)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription< S> -
Adds a subscription to the
Stream<State>
. Returns a StreamSubscription which handles events from theStream<State>
using the providedonData
,onError
andonDone
handlers.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
. -
onError(
Object error, StackTrace stackTrace) → void -
Called whenever an
error
occurs and notifiesBlocObserver.onError
.inherited -
replace(
S state) → void - Replace global state with a state from parameter state
-
subState<
T> (T mapper(S state)) → Stream< T> - Get a substate of the state with a mapper function
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
S stateUpdater(S state)) → void - Update global state with a stateUpdater function - sometimes it's more convenient than use replace
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited