PersistroMastro<T> class

Persistent version of Mastro state container.

Inheritance
Mixed-in types
Available extensions

Constructors

PersistroMastro({required T initial, required String key, required T decoder(String), required String encoder(T), bool autoSave = true})
Creates a persistent Mastro state container.

Properties

autoSave bool
Whether to automatically save on changes.
final
decoder → T Function(String)
Function to decode stored string into value of type T.
final
encoder String Function(T)
Function to encode value of type T into string.
final
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
key String
Unique key for storing this state.
final
nonNotifiableSetter ← T
Sets the value without notifying listeners.
no getterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
value ↔ T
Gets or sets the current value.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
build({required Widget builder(Basetro<T> state, BuildContext context)}) Widget

Available on Basetro<T>, provided by the BasetroBuilderTools extension

Creates a MastroBuilder widget for this state object.
clear() Future<void>
Clears the persisted value.
inherited
compute<R>(R calculator(T value)) Mastro<R>
Creates a computed state that depends on this state.
inherited
debugLog([String? name]) → void

Available on Basetro<T>, provided by the BasetroDebug extension

Logs state changes to the console.
dependsOn(Basetro other) → void
Adds a dependency on another state.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
override
disposePersistence() → void
Cleans up persistence resources.
inherited
initPersistence() → void
Initializes the persistence system.
inherited
modify(void modify(Mutable<T> state)) → void
Modifies the state with a callback.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notify() → void
Notifies listeners of state changes.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
notifyObservers() → void
Notifies all observers of state changes.
inherited
observe(String key, void callback(T value)) → void
Adds an observer callback.
inherited
persist() Future<void>
Persists the current value.
inherited
removeDependency(Mastro other) → void
Removes a dependency.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
removeObserver(String key) → void
Removes an observer.
inherited
restore() Future<void>
Restores the persisted value.
inherited
setValidator(bool validator(T value)) → void
Sets a validation function for value changes.
inherited
toggle() → void

Available on Basetro<bool>, provided by the MastroBoolTools extension

Toggles the boolean value.
toString() String
A string representation of this object.
inherited

Operators

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

Static Methods

boolean(String key, {bool initial = false, bool autoSave = true}) PersistroMastro<bool>
Creates a persistent boolean state container.
list<T>(String key, {required List<T> initial, required T fromJson(dynamic), bool autoSave = true}) PersistroMastro<List<T>>
Creates a persistent list state container.
map<T>(String key, {required Map<String, T> initial, required T fromJson(dynamic), bool autoSave = true}) PersistroMastro<Map<String, T>>
Creates a persistent map state container.
number(String key, {num initial = 0.0, bool autoSave = true}) PersistroMastro<num>
Creates a persistent numeric state container.
string(String key, {String initial = '', bool autoSave = true}) PersistroMastro<String>
Creates a persistent string state container.