LxFuture<T> class

A reactive wrapper for a Future.

LxFuture manages the lifecycle and status of an asynchronous operation, providing synchronous access to its progress via LxStatus.

Usage

final user = fetchUser().lx;
LWatch(() => user.isWaiting ? CircularProgressIndicator() : UserView(user.requireValue));

Inheritance

Available extensions

LxStatusReactiveExtensions

Constructors

LxFuture(Future<T> future, {T? initial}): Executes future immediately and tracks its status.
LxFuture.from(Future<T> futureCallback(), {T? initial}): Convenience factory to create an LxFuture from a closure.
factory
LxFuture.idle({T? initial}): Creates an LxFuture in an LxIdle state.

Properties

asLxStream → LxStream<T>: Returns an LxStream representation of this future.
no setter
computedValue → T: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Alias for requireValue.
no setter
errorOrNull → Object?: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns the current error if the status is LxError, otherwise null.
no setter
graphDepth ↔ int: Returns the current depth in the dependency graph.
getter/setter pairinherited
hashCode → int: The hash code for this object.
no setterinherited
hasListener → bool: Whether there are active listeners.
no setterinherited
hasValue → bool: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Alias for isSuccess.
no setter
id → int: A unique runtime identifier for this reactive instance.
finalinherited
isDisposed → bool: Whether the reactive object has been closed/disposed.
no setterinherited
isError → bool: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns true if the status is LxError.
no setter
isIdle → bool: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns true if the status is LxIdle.
no setter
isLoading → bool: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Alias for isWaiting.
no setter
isSuccess → bool: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns true if the status is LxSuccess.
no setter
isWaiting → bool: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns true if the status is LxWaiting.
no setter
lastValue → T?: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns the LxStatus.lastValue (the most recent successful value).
no setter
name ↔ String?: An optional descriptive name for debugging and profiling.
getter/setter pairinherited
onCancel → void Function()?: Called when the stream is cancelled.
finalinherited
onListen → void Function()?: Called when the stream is listened to.
finalinherited
ownerId ↔ String?: The registration key of the owning controller, if applicable.
getter/setter pairinherited
requireValue → T: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Force-retrieves the current value if the status is LxSuccess.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
stackTraceOrNull → StackTrace?: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns the stack trace if the status is LxError, otherwise null.
no setter
status → LxStatus<T>: Returns the current LxStatus of the operation.
no setter
stream → Stream<LxStatus<T>>: A Stream that emits the latest value whenever it updates.
no setterinherited
value → LxStatus<T>: The current state of the reactive object.
no setterinherited
valueOrNull → T?: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns the current value if the status is LxSuccess, otherwise null.
no setter
wait → Future<T>: Returns a Future that completes when the operation succeeds or fails.
no setter
wait → Future<T>: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Returns a Future that completes when the operation reaches a terminal state.
no setter

Methods

addListener(void listener()) → void: Adds a listener.
inherited
bind(Stream<LxStatus<T>> externalStream) → void: Binds an external stream to this reactive variable.
inherited
call() → LxStatus<T>: Functor-like call to get value.
inherited
close() → void: Permanently closes the reactive object and releases all internal resources.
inherited
dispose() → void: Disposes the notifier.
inherited
listen(void onSuccess(T value), {void onIdle()?, void onWaiting()?, void onError(Object error)?, dynamic onProcessingError(Object error, StackTrace stackTrace)?}) → LxWorker<LxStatus<T>>: Available on LxReactive<LxStatus<T>>, provided by the LxStatusReactiveExtensions extension
Specialized listen for async status that allows handling individual states.
mutate(void mutator(LxStatus<T> value)) → void: Mutates the value in place and triggers a refresh.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notify() → void: Alias for refresh.
inherited
refresh() → void: Triggers a notification without changing the value.
inherited
removeListener(void listener()) → void: Removes a listener.
inherited
restart(Future<T> future) → void: Re-executes the operation with a new future.
setValueInternal(LxStatus<T> val, {bool notifyListeners = true}) → void: Internal setter for subclasses (Computed, etc.)
inherited
toString() → String: A string representation of this object.
override
transform<R>(Stream<R> transformer(Stream<LxStatus<T>> stream)) → LxStream<R>: Transforms the status sequence into a new LxStream.
inherited
unbind() → void: Unbinds any external stream.
inherited
updateValue(LxStatus<T> fn(LxStatus<T> val)) → void: Updates the value using a transformation function.
inherited

Operators

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