BaseViewModelHydratedCubit<S> class abstract

Minimal hydrated base for Cubit view models.

Extend this class and implement toJson and fromJson for your state type S.

Constructors

BaseViewModelHydratedCubit(S state)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

id → String

id is used to uniquely identify multiple instances of the same HydratedBloc type. In most cases it is not necessary; however, if you wish to intentionally have multiple instances of the same HydratedBloc, then you must override id and return a unique identifier for each HydratedBloc instance in order to keep the caches independent of each other.

no setter, inherited

isClosed → bool

Whether the bloc is closed.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state → S

The current state.

no setter, inherited

stateCurrentValue ← S

Convenient setter to update current state.

no getter

storagePrefix → String

Storage prefix which can be overridden to provide a custom storage namespace. Defaults to runtimeType but should be overridden in cases where stored data should be resilient to obfuscation, minification or persist between debug/release builds.

no setter, inherited

storageToken → String

storageToken is used as registration token for hydrated storage. Composed of storagePrefix and id.

no setter, inherited

stream → Stream<S>

The current stream of states.

no setter, inherited

Methods

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

Reports an error which triggers onError with an optional StackTrace.

inherited

clear() → Future<void>

clear is used to wipe or invalidate the cache of a HydratedBloc. Calling clear will delete the cached state of the bloc but will not modify the current state of the bloc.

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 provided state. emit does nothing if the state being emitted is equal to the current state.

inherited

fromJson(Map<String, dynamic> json) → S?

Deserialize state from JSON for hydration.

hydrate({Storage? storage, OnHydrationError onError = defaultOnHydrationError}) → void

Populates the internal state storage with the latest state. This should be called when using the HydratedMixin directly within the constructor body.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onChange(Change<S> change) → void

Keep default HydratedCubit behavior; subclasses may override if needed.

onError(Object error, StackTrace stackTrace) → void

Called whenever an error occurs and notifies BlocObserver.onError.

inherited

stateChanger(S state) → void

Emits the next state.

toJson(S state) → Map<String, dynamic>?

Serialize state to JSON for hydration.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited