SingleCubit<Value, Filter, ExtraData> class
It allows you to wait for the fetch of a value, if it is not successful it notifies the failure, if the value does not exist it notifies the non-existence otherwise it notifies the new value.
- Inheritance
-
- Object
- BlocBase<
ObjectCubitState< Value, ExtraData> > - Cubit<
ObjectCubitState< Value, ExtraData> > - ObjectCubit<
Value, ExtraData> - SingleCubit
- Available Extensions
Constructors
-
SingleCubit({ValueFetcher<
Value, Filter> ? fetcher, Filter? initialFilter, bool canWaitFirstFilter = false, bool filterEquals(Filter? e1, Filter? e2)?, Duration? filterDebounceTime, ExtraData? initialExtraData}) - Create the cubit that is waiting to receive a value, the initial state is ObjectCubitUpdating
-
SingleCubit.empty({ValueFetcher<
Value, Filter> ? fetcher, Filter? initialFilter, bool canWaitFirstFilter = false, bool filterEquals(Filter? e1, Filter? e2)?, Duration? filterDebounceTime, ExtraData? initialExtraData}) - Create the cubit without a value, the initial state is ObjectCubitUpdated
-
SingleCubit.seed({ValueFetcher<
Value, Filter> ? fetcher, Filter? initialFilter, bool canWaitFirstFilter = false, bool filterEquals(Filter? e1, Filter? e2)?, Duration? filterDebounceTime, ExtraData? initialExtraData, required Value initialValue}) - Create the cubit with an initial value, the initial state is ObjectCubitUpdated
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isClosed → bool
-
Whether the bloc is closed.
no setterinherited
-
onFilterChanges
→ Stream<
Filter?> -
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
→ ObjectCubitState<
Value, ExtraData> -
The current state.
no setterinherited
-
stream
→ Stream<
ObjectCubitState< Value, ExtraData> > -
The current state stream.
no setterinherited
Methods
-
addError(
Object error, [StackTrace? stackTrace]) → void -
Reports an
error
which triggers onError with an optional StackTrace.inherited -
applyFetcher(
{required ValueFetcher< Value, Filter> fetcher}) → void -
applyFilter(
{required Filter? filter}) → void -
inherited
-
applyFilterChanges(
{required Stream< Filter?> onFilterChanges}) → void -
inherited
-
applyFilterCubit(
{required ObjectCubit< Filter?, Object> filterCubit}) → void -
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.
override
-
emit(
ObjectCubitState< Value, ExtraData> 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 -
fetch(
) → void -
listen(
void onData(ObjectCubitState< Value, ExtraData> )?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<ObjectCubitState< Value, ExtraData> > -
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< ObjectCubitState< change) → voidValue, ExtraData> > -
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 -
reset(
) → void -
override
-
toString(
) → String -
A string representation of this object.
inherited
-
updateExtraData(
ExtraData extraData) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited