Injected<T> class Null safety

A Wrapper class that encloses the state of the model we want to Inject. The state can be mutable or immutable and can also be global or local.

Injected model can be instantiated globally or as a member of classes. They can be instantiated inside the build method without losing the state after rebuilds.

  • Injected lifecycle: The state wrapped by the Injected model has a lifecycle. It is created when first used and destroyed when no longer used even if it is declared globally. Between the creation and the destruction of the state, it can be listened to and mutated to notify its registered listeners.
  • Injected state and null safety: The state of an injected model is null safe, that is it can not be null. For this reason the initial state will be inferred by the library, and in case it is not, it must be defined explicitly. The initial state of primitives is inferred as follows: (int: 0, double, 0.0, String:'', and bool: false). For other non-primitive objects the initial state will be the first created instance.
  • Listening to an Injected: To listen to an Injected model you can use one of the following options: ReactiveModelBuilder.listen, ReactiveModelBuilder.futureBuilder, ReactiveModelBuilder.streamBuilder, ReactiveModelBuilder.rebuilder, ReactiveModelBuilder.whenRebuilder, and ReactiveModelBuilder.whenRebuilderOr.
  • Injected state cleaning: When the state is disposed of, its list of listeners is cleared, and if the state is waiting for a Future or subscribed to a Stream, it will cancel them to free resources.
  • State persistence: Injected state can be persisted using PersistState. By default the state is persisted each time the state is mutated. You can set it to persist manually or when the state is disposed. You can also throttle state persistence for the time you want.
  • Undo redo state mutation: You can undo or redo state mutation by defining the undoStackLength parameter of RM.inject RM.injectFuture, RM.injectStream or RM.injectFlavor. After state mutation you can redo it using ReactiveModelUndoRedoState.undoState and redo it using ReactiveModelUndoRedoState.redoState.
  • Injected model dependence Injected models can depend on other Injected models and recalculate its state and notify its listeners whenever any of its of the Inject model that it depends on emits a notification.
Inheritance
Implementers
Available Extensions

Constructors

Injected()

Properties

autoDisposeWhenNotUsed bool
read-only, inherited
canRedoState bool
Whether the state can be redone.
read-only
canUndoState bool
Whether the state can be done
read-only
connectionState ConnectionState
read-only, inherited
customStatus Object?
Custom status of the state. Set manually to mark the state with a particular tag to be used in your logic.
read / write, inherited
debugMessage String?
read / write, inherited
error → dynamic
The error
read-only, inherited
hasData bool
The state is mutated successfully.
read-only, inherited
hasError bool
The stats has error
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
hasObservers bool
Whether the state has observers
read-only, inherited
isActive bool
Whether the state is active or not. [...]
read-only, inherited
isDone bool
The state is mutated using a stream and the stream is done.
read-only, inherited
isIdle bool
The state is initialized and never mutated.
read-only, inherited
isWaiting bool
The state is waiting for and asynchronous task to end.
read-only, inherited
observerLength int
read-only, inherited
oldSnapState SnapState<T>
read-only, inherited
rebuild → _Rebuild<T>
Callable class used to listen to a reactive (injected) model and rebuild widget [...]
late, final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
snapState SnapState<T>
A snap representation of the state
read / write, inherited
state ↔ T
read / write, inherited
stateAsync Future<T>
It is a future of the state. The future is active if the state is on the isWaiting status.
read-only, inherited
subscription StreamSubscription?
It is not null if the state is waiting for a Future or is subscribed to a Stream
read-only, inherited

Methods

call(BuildContext context, {bool defaultToGlobal = false}) Injected<T>
Obtain the Injected model from the nearest InheritedWidget inserted using inherited. [...]
catchError(void onError(dynamic error, StackTrace s)) Future<InjectedBase<T>>
inherited
clearUndoStack() → void
Clear undoStack;
deletePersistState() → void
Delete the state form the persistence store
dispose() → void
Dispose the state.
inherited
future<F>(Future<F> future(T s)) Future<F> Function()
inherited({required Widget builder(BuildContext), Key? key, FutureOr<T> stateOverride()?, bool connectWithGlobal = true, String? debugPrintWhenNotifiedPreMessage, String toDebugString(T?)?}) Widget
Provide the injected model using an InheritedWidget that wraps its state. [...]
initializeState() FutureOr<T>
Initialize the state
inherited
injectFutureMock(Future<T> fakeCreator()) → void
Inject a fake future implementation of this injected model. [...]
injectMock(T fakeCreator()) → void
Inject a fake implementation of this injected model. [...]
injectStreamMock(Stream<T> fakeCreator()) → void
Inject a fake stream implementation of this injected model. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
notify() → void
Notify observers
inherited
of(BuildContext context, {bool defaultToGlobal = false}) → T
Obtain the state from the nearest InheritedWidget inserted using inherited. [...]
onAll<R>({R onIdle()?, required R onWaiting()?, required R onError(dynamic error, VoidCallback refreshError)?, required R onData(T data)}) → R
inherited
onErrorRefresher() → void
IF the state is in the hasError status, The last callback that causes the error can be reinvoked.
inherited
onOrElse<R>({R onIdle()?, R onWaiting()?, R onError(dynamic error, VoidCallback refreshError)?, R onData(T data)?, required R orElse(T data)}) → R
inherited
persistState() → void
Persist the state
redoState() → void
Redo to the next valid state (isWaiting and hasError are ignored)
refresh() Future<T?>
Refresh the Injected state. Refreshing the state means reinitialize it and reinvoke its creation function and notify its listeners. [...]
inherited
reInherited({Key? key, required BuildContext context, required Widget builder(BuildContext)}) Widget
Provide the Injected model to another widget tree branch.
setState<R>(FutureOr<R> fn(T s), {void onData(T data)?, void onError(dynamic error)?, On<void>? onSetState, void onRebuildState()?, SideEffects<T>? sideEffects, int debounceDelay = 0, int throttleDelay = 0, bool shouldAwait = false, bool skipWaiting = false, BuildContext? context, bool shouldOverrideDefaultSideEffects(SnapState<T> snap)?}) Future<T>
Mutate the state of the model and notify observers. [...]
inherited
subscribeToRM(void fn(SnapState<T>? snap)) VoidCallback
Subscribe to the state
inherited
toggle() → void
If the state is bool, toggle it and notify listeners [...]
inherited
toString() String
A string representation of this object. [...]
inherited
undoState() → void
Undo to the last valid state (isWaiting and hasError are ignored)
whenConnectionState<R>({required R onIdle(), required R onWaiting(), required R onData(T snapState), required R onError(dynamic error), bool catchError = true}) → R
Exhaustively switch over all the possible statuses of connectionState. Used mostly to return Widgets.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited