CancellableFuture<T> class

A future associated to a job that can be cancelled. If you use an API method that return this future and don't have an interest in the result anymore you should call the cancel method, or the job will keep running and waste resources. Note that the future's job will only be cancelled when cancel is explicitly called: if you use timeout and the timeLimit expires the job will keep executing.

Implemented types
Available extensions

Constructors

CancellableFuture.internalConstructor(Future<T> _future, int _cancellationToken)

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
cancel() → Future<void>
Cancels the execution of the job that will complete this future. This method returns as soon as the job has been notified of the cancellation request, however note that this does not mean that the job has been cancelled or will be cancelled. Jobs can only be cancelled while they are performing certain operations (for example while performing web requests). If the job has received a cancellation request, but the job does not perform any more cancellable operations before completion the future will be completed normally (with a success or error, but not with a cancellation).
catchError(Function onError, {bool test(Object error)?}) → CancellableFuture<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}) → CancellableFuture<R>
Register callbacks to be called when this future completes.
override
timeout(Duration timeLimit, {FutureOr<T> onTimeout()?}) → CancellableFuture<T>
Stop waiting for this future after timeLimit has passed.
override
toString() → String
A string representation of this object.
inherited
whenComplete(FutureOr<void> action()) → CancellableFuture<T>
Registers a function to be called when this future completes.
override

Operators

operator &(Future<BaseFilterOptions<E>> other) → Future<BaseFilterOptions<E>>

Available on Future<BaseFilterOptions<E>>, provided by the BaseMetaFilter extension

operator &(Future<BaseFilterOptions<E>> other) → Future<BaseSortableFilterOptions<E>>

Available on Future<BaseSortableFilterOptions<E>>, provided by the BaseSortableMetaFilter extension

operator &(Future<FilterOptions<E>> other) → Future<FilterOptions<E>>

Available on Future<FilterOptions<E>>, provided by the MetaFilter extension

operator &(Future<FilterOptions<E>> other) → Future<SortableFilterOptions<E>>

Available on Future<SortableFilterOptions<E>>, provided by the SortableMetaFilter extension

operator -(Future<BaseFilterOptions<E>> other) → Future<BaseFilterOptions<E>>

Available on Future<BaseFilterOptions<E>>, provided by the BaseMetaFilter extension

operator -(Future<BaseFilterOptions<E>> other) → Future<BaseSortableFilterOptions<E>>

Available on Future<BaseSortableFilterOptions<E>>, provided by the BaseSortableMetaFilter extension

operator -(Future<FilterOptions<E>> other) → Future<FilterOptions<E>>

Available on Future<FilterOptions<E>>, provided by the MetaFilter extension

operator -(Future<FilterOptions<E>> other) → Future<SortableFilterOptions<E>>

Available on Future<SortableFilterOptions<E>>, provided by the SortableMetaFilter extension

operator ==(Object other) → bool
The equality operator.
inherited
operator |(Future<BaseFilterOptions<E>> other) → Future<BaseFilterOptions<E>>

Available on Future<BaseFilterOptions<E>>, provided by the BaseMetaFilter extension

operator |(Future<FilterOptions<E>> other) → Future<FilterOptions<E>>

Available on Future<FilterOptions<E>>, provided by the MetaFilter extension