RebuildableNotifier<T, R> mixin

A notifier that can be rebuilt. In other words: The provider build lambda can be called again without the notifier being disposed.

T is the state type. R is the return type of _builder.

Implemented types

• Rebuildable

Mixin Applications

• FamilyNotifier
• FutureProviderNotifier
• StreamProviderNotifier
• ViewProviderNotifier

Properties

customDebugLabel → String?

Override this to provide a custom debug label.

no setter, inherited

debugLabel → String

A label to be used in debug messages and by the RefenaTracingPage.

no setter, inherited

dependencies → Set<BaseNotifier>

A collection of notifiers that this notifier depends on.

final, inherited

dependents → Set<BaseNotifier>

A collection of notifiers that depend on this notifier. They will be disposed when this notifier is disposed.

final, inherited

disposed → bool

Whether this notifier is disposed.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isWidget → bool

Whether this Rebuildable is an ElementRebuildable. This is a workaround for the fact that ElementRebuildable is in refena_flutter so we cannot refer it from here.

no setter, override

provider → BaseProvider<BaseNotifier<T>, T>?

The provider that created this notifier. This is only available after the initialization.

no setter, inherited

requireBuildContext → bool

If this is true, initializing must be done by ViewModelBuilder of the refena_flutter package. This flag is needed to throw an exception if the user forgets to use ViewModelBuilder.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ T

Gets the current state.

getter/setter pair, inherited

Methods

addListener(Rebuildable rebuildable, ListenerConfig<T> config) → void

inherited

cleanupListeners() → void

inherited

describeState(T state) → String

Override this to provide a customized description of the state. This is used by the built-in observers for improved logging.

inherited

dispose() → void

This is called on Ref.dispose. You can override this method to dispose resources.

getListeners() → List<Rebuildable>

inherited

getStream() → Stream<NotifierEvent<T>>

inherited

internalSetup(ProxyRef ref, BaseProvider<BaseNotifier<T>, T>? provider) → void

Handles the actual initialization of the notifier. Calls init internally.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListenerTarget(BaseNotifier notifier) → void

Only for ElementRebuildable. Noop for others. Notifies that a new BaseNotifier is being listened. This should be called within a build method so it can unwatch old notifiers in the next microtask.

override

onDisposeWidget() → void

Only for ElementRebuildable. Noop for others. Allows for further cleanup logic.

override

postInit() → void

Override this to provide a custom post initialization. The initial state is already set at this point.

inherited

rebuild(ChangeEvent? changeEvent, RebuildEvent? rebuildEvent) → void

Schedules a rebuild in the next microtask.

override

rebuildImmediately(LabeledReference debugOrigin) → R

Rebuilds the notifier immediately.

removeListener(Rebuildable rebuildable) → void

inherited

toString() → String

A string representation of this object.

inherited

updateShouldNotify(T prev, T next) → bool

Override this if you want to a different kind of equality.

inherited

Operators

operator ==(Object other) → bool

Subclasses should not override this method. It is used internally by dependencies and dependents.

inherited