DisposableFuture<T> class

A future that is disposable, which cancels the underlying operation, if any. Even if the operation finishes, then will not be fired if dispose is called first.

Implemented types
Available extensions

Constructors

DisposableFuture(Future<T> _delegateFuture, DisposeFunction _disposeFn)
Wraps a future and passes a function that should cancel the operation.
DisposableFuture.first(Stream<T> stream)
Returns a disposable version of stream.first.
factory
DisposableFuture.fromFuture(Future<T> future)
Returns a disposable version of Future by converting it into a stream.
factory
DisposableFuture.fromValue(T value)
Returns a disposable version of Future by placing the value in a stream.
factory
DisposableFuture.last(Stream<T> stream)
Returns a disposable version of stream.last.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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

Methods

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
dispose() → void
Disposes this disposable and any resources it has open.
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<S>(FutureOr<S> onValue(T value), {Function? onError}) → DisposableFuture<S>
Register callbacks to be called when this future completes.
override
timeout(Duration timeLimit, {dynamic onTimeout()?}) → Future<T>
Stop waiting for this future after timeLimit has passed.
override
toString() → String
A string representation of this object.
inherited
whenComplete(dynamic action()) → Future<T>
Registers a function to be called when this future completes.
override

Operators

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