RxFuture<T> class

The RxFuture is the reactive wrapper around a Future. You can use it to show the UI under various states of a Future, from pending to fulfilled or rejected.

The status, result and error fields of an RxFuture are observable and can be consumed on the UI. You can add a new Future using .value.

Implemented types

• Future<T>

Available extensions

• FutureExtensions
• FutureOfJSAnyToJSPromise
• FutureOfVoidToJSPromise
• RxFutureExtension

Annotations

• @Deprecated('Collections, Futures and Streams will no longer be ' 'supported by this package as they violate the ASP standard. ' 'It is better to use a pure [Atom] synchronously ' 'to understand the flow of reactivity.')

Properties

data → T?

The current value, that may be null

no setter

error → dynamic

The current error

no setter

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → FutureStatus

The current status

no setter

toJS → JSPromise<T>

Available on Future<T>, provided by the FutureOfJSAnyToJSPromise extension

A JSPromise that either resolves with the result of the completed Future or rejects with an object that contains its error.

no setter

toJS → JSPromise<JSAny?>

Available on Future<void>, provided by the FutureOfVoidToJSPromise extension

A JSPromise that either resolves once this Future completes or rejects with an object that contains its error.

no setter

value ↔ Future<T>

Returns the future value

getter/setter pair

Methods

asAtom() → RxFuture<T>

Available on Future<T>, provided by the RxFutureExtension extension

Convert a Future to RxFuture.

asStream() → Stream<T>

Creates a Stream containing the result of this future.

override

catchError(Function onError, {bool test(Object error)?}) → Future<T>

Handles errors emitted by this Future.

override

ignore() → void

Available on Future<T>, provided by the FutureExtensions extension

Completely ignores this future and its result.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onError<E extends Object>(FutureOr<T> handleError(E error, StackTrace stackTrace), {bool test(E error)?}) → Future<T>

Available on Future<T>, provided by the FutureExtensions extension

Handles errors on this future.

then<R>(FutureOr<R> onValue(T value), {Function? onError}) → Future<R>

Register callbacks to be called when this future completes.

override

timeout(Duration timeLimit, {FutureOr<T> onTimeout()?}) → Future<T>

Stop waiting for this future after timeLimit has passed.

override

toString() → String

A string representation of this object.

inherited

whenComplete(FutureOr<void> action()) → Future<T>

Registers a function to be called when this future completes.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

of<T>(Future<T> future) → RxFuture<T>

Creates a RxFuture from a future. {@tool snippet}