Uses of Interface
io.vavr.concurrent.Future

Packages that use Future

Package	Description
io.vavr	Beside API the io.vavr package contains core types like (Checked)Functions and Tuples.
io.vavr.concurrent	This package contains basic building blocks for creating fast, asynchronous, non-blocking parallel code.

Uses of Future in io.vavr

Fields in io.vavr declared as Future

Modifier and Type	Field	Description
private final Future<T1>	API.For1Future.ts1
private final Future<T1>	API.For2Future.ts1
private final Future<T1>	API.For3Future.ts1
private final Future<T1>	API.For4Future.ts1
private final Future<T1>	API.For5Future.ts1
private final Future<T1>	API.For6Future.ts1
private final Future<T1>	API.For7Future.ts1
private final Future<T1>	API.For8Future.ts1
private final Future<T2>	API.For2Future.ts2
private final Future<T2>	API.For3Future.ts2
private final Future<T2>	API.For4Future.ts2
private final Future<T2>	API.For5Future.ts2
private final Future<T2>	API.For6Future.ts2
private final Future<T2>	API.For7Future.ts2
private final Future<T2>	API.For8Future.ts2
private final Future<T3>	API.For3Future.ts3
private final Future<T3>	API.For4Future.ts3
private final Future<T3>	API.For5Future.ts3
private final Future<T3>	API.For6Future.ts3
private final Future<T3>	API.For7Future.ts3
private final Future<T3>	API.For8Future.ts3
private final Future<T4>	API.For4Future.ts4
private final Future<T4>	API.For5Future.ts4
private final Future<T4>	API.For6Future.ts4
private final Future<T4>	API.For7Future.ts4
private final Future<T4>	API.For8Future.ts4
private final Future<T5>	API.For5Future.ts5
private final Future<T5>	API.For6Future.ts5
private final Future<T5>	API.For7Future.ts5
private final Future<T5>	API.For8Future.ts5
private final Future<T6>	API.For6Future.ts6
private final Future<T6>	API.For7Future.ts6
private final Future<T6>	API.For8Future.ts6
private final Future<T7>	API.For7Future.ts7
private final Future<T7>	API.For8Future.ts7
private final Future<T8>	API.For8Future.ts8

Methods in io.vavr that return Future

Modifier and Type	Method	Description
static <T> Future<T>	API.Future(CheckedFunction0<? extends T> computation)	Alias for Future.of(CheckedFunction0)
static <T> Future<T>	API.Future(Executor executorService, CheckedFunction0<? extends T> computation)	Alias for Future.of(Executor, CheckedFunction0)
static <T> Future<T>	API.Future(Executor executorService, T result)	Alias for Future.successful(Executor, Object)
static <T> Future<T>	API.Future(T result)	Alias for Future.successful(Object)
Future<T1>	API.For1Future.yield()	A shortcut for yield(Function.identity()).
<R> Future<R>	API.For1Future.yield(Function<? super T1, ? extends R> f)	Yields a result for elements of the cross product of the underlying Future.
<R> Future<R>	API.For2Future.yield(BiFunction<? super T1, ? super T2, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.
<R> Future<R>	API.For3Future.yield(Function3<? super T1, ? super T2, ? super T3, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.
<R> Future<R>	API.For4Future.yield(Function4<? super T1, ? super T2, ? super T3, ? super T4, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.
<R> Future<R>	API.For5Future.yield(Function5<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.
<R> Future<R>	API.For6Future.yield(Function6<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? super T6, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.
<R> Future<R>	API.For7Future.yield(Function7<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? super T6, ? super T7, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.
<R> Future<R>	API.For8Future.yield(Function8<? super T1, ? super T2, ? super T3, ? super T4, ? super T5, ? super T6, ? super T7, ? super T8, ? extends R> f)	Yields a result for elements of the cross product of the underlying Futures.

Methods in io.vavr that return types with arguments of type Future

Modifier and Type	Method	Description
static <T, _1 extends Option<Try<T>>> API.Match.Pattern1<Future<T>, _1>	Patterns.$Future(API.Match.Pattern<_1,?> p1)

Methods in io.vavr with parameters of type Future

Modifier and Type	Method	Description
static <T1> API.For1Future<T1>	API.For(Future<T1> ts1)	Creates a For-comprehension of one Future.
static <T1,T2> API.For2Future<T1,T2>	API.For(Future<T1> ts1, Future<T2> ts2)	Creates a For-comprehension of two Futures.
static <T1,T2,T3> API.For3Future<T1,T2,T3>	API.For(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3)	Creates a For-comprehension of three Futures.
static <T1,T2,T3,T4> API.For4Future<T1,T2,T3,T4>	API.For(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4)	Creates a For-comprehension of 4 Futures.
static <T1,T2,T3,T4,T5> API.For5Future<T1,T2,T3,T4,T5>	API.For(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5)	Creates a For-comprehension of 5 Futures.
static <T1,T2,T3,T4,T5,T6> API.For6Future<T1,T2,T3,T4,T5,T6>	API.For(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5, Future<T6> ts6)	Creates a For-comprehension of 6 Futures.
static <T1,T2,T3,T4,T5,T6,T7> API.For7Future<T1,T2,T3,T4,T5,T6,T7>	API.For(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5, Future<T6> ts6, Future<T7> ts7)	Creates a For-comprehension of 7 Futures.
static <T1,T2,T3,T4,T5,T6,T7,T8> API.For8Future<T1,T2,T3,T4,T5,T6,T7,T8>	API.For(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5, Future<T6> ts6, Future<T7> ts7, Future<T8> ts8)	Creates a For-comprehension of 8 Futures.
(package private) static <T> Tuple1<Option<Try<T>>>	$.Future(Future<T> future)

Constructors in io.vavr with parameters of type Future

Modifier	Constructor	Description
private	For1Future(Future<T1> ts1)
private	For2Future(Future<T1> ts1, Future<T2> ts2)
private	For3Future(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3)
private	For4Future(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4)
private	For5Future(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5)
private	For6Future(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5, Future<T6> ts6)
private	For7Future(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5, Future<T6> ts6, Future<T7> ts7)
private	For8Future(Future<T1> ts1, Future<T2> ts2, Future<T3> ts3, Future<T4> ts4, Future<T5> ts5, Future<T6> ts6, Future<T7> ts7, Future<T8> ts8)

Uses of Future in io.vavr.concurrent

Classes in io.vavr.concurrent that implement Future

Modifier and Type	Class	Description
(package private) final class	FutureImpl<T>	INTERNAL API - This class is subject to change.

Methods in io.vavr.concurrent that return Future

Modifier and Type	Method	Description
default Future<T>	Future.andThen(Consumer<? super Try<T>> action)	Support for chaining of callbacks that are guaranteed to be executed in a specific order.
Future<T>	Future.await()	Blocks the current Thread until this Future completed or returns immediately if this Future is already completed.
Future<T>	Future.await(long timeout, TimeUnit unit)	Blocks the current Thread until this Future completed or returns immediately if this Future is already completed.
Future<T>	FutureImpl.await()
Future<T>	FutureImpl.await(long timeout, TimeUnit unit)
default <R> Future<R>	Future.collect(PartialFunction<? super T, ? extends R> partialFunction)	Collects value that is in the domain of the given partialFunction by mapping the value to type R.
default Future<Throwable>	Future.failed()	A projection that inverses the result of this Future.
static <T> Future<T>	Future.failed(Throwable exception)	Creates a failed Future with the given exception, backed by the Future.DEFAULT_EXECUTOR.
static <T> Future<T>	Future.failed(Executor executor, Throwable exception)	Creates a failed Future with the given exception, backed by the given Executor.
default Future<T>	Future.fallbackTo(Future<? extends T> that)	Returns a Future that returns the result of this Future, if it is a success.
default Future<T>	Future.filter(Predicate<? super T> predicate)	Shortcut for filterTry(predicate::test.
default Future<T>	Future.filterTry(CheckedPredicate<? super T> predicate)	Filters the result of this Future by calling Try.filterTry(CheckedPredicate).
static <T> Future<Option<T>>	Future.find(Iterable<? extends Future<? extends T>> futures, Predicate<? super T> predicate)	Returns a Future that eventually succeeds with the first result of the given Futures which matches the given predicate.
static <T> Future<Option<T>>	Future.find(Executor executor, Iterable<? extends Future<? extends T>> futures, Predicate<? super T> predicate)	Returns a Future that eventually succeeds with the first result of the given Futures which matches the given predicate.
static <T> Future<T>	Future.firstCompletedOf(Iterable<? extends Future<? extends T>> futures)	Returns a new Future that will contain the result of the first of the given futures that is completed, backed by the Future.DEFAULT_EXECUTOR.
static <T> Future<T>	Future.firstCompletedOf(Executor executor, Iterable<? extends Future<? extends T>> futures)	Returns a new Future that will contain the result of the first of the given futures that is completed, backed by the given Executor.
default <U> Future<U>	Future.flatMap(Function<? super T, ? extends Future<? extends U>> mapper)
default <U> Future<U>	Future.flatMapTry(CheckedFunction1<? super T, ? extends Future<? extends U>> mapper)
static <T,U> Future<U>	Future.fold(Iterable<? extends Future<? extends T>> futures, U zero, BiFunction<? super U, ? super T, ? extends U> f)	Returns a Future which contains the result of the fold of the given future values.
static <T,U> Future<U>	Future.fold(Executor executor, Iterable<? extends Future<? extends T>> futures, U zero, BiFunction<? super U, ? super T, ? extends U> f)	Returns a Future which contains the result of the fold of the given future values.
static <T> Future<T>	Future.fromCompletableFuture(CompletableFuture<T> future)	Creates a Future with the given CompletableFuture, backed by the Future.DEFAULT_EXECUTOR
static <T> Future<T>	Future.fromCompletableFuture(Executor executor, CompletableFuture<T> future)	Creates a Future with the given CompletableFuture, backed by given Executor
static <T> Future<T>	Future.fromJavaFuture(Executor executor, Future<T> future)	Creates a Future with the given java.util.concurrent.Future, backed by given Executor
static <T> Future<T>	Future.fromJavaFuture(Future<T> future)	Creates a Future with the given java.util.concurrent.Future, backed by the Future.DEFAULT_EXECUTOR
static <T> Future<T>	Future.fromTry(Try<? extends T> result)	Creates a Future from a Try, backed by the Future.DEFAULT_EXECUTOR.
static <T> Future<T>	Future.fromTry(Executor executor, Try<? extends T> result)	Creates a Future from a Try, backed by the given Executor.
Future<T>	Promise.future()	Returns the underlying Future of this Promise.
Future<T>	PromiseImpl.future()
default <U> Future<U>	Future.map(Function<? super T, ? extends U> mapper)
default <U> Future<U>	Future.mapTry(CheckedFunction1<? super T, ? extends U> mapper)
static <T> Future<T>	Future.narrow(Future<? extends T> future)	Narrows a widened Future<? extends T> to Future<T> by performing a type-safe cast.
static <T> Future<T>	Future.of(CheckedFunction0<? extends T> computation)	Starts an asynchronous computation, backed by the Future.DEFAULT_EXECUTOR.
static <T> Future<T>	Future.of(Executor executor, CheckedFunction0<? extends T> computation)	Starts an asynchronous computation, backed by the given Executor.
static <T> Future<T>	Future.ofCallable(Callable<? extends T> computation)	Deprecated. Will be removed.
static <T> Future<T>	Future.ofCallable(Executor executor, Callable<? extends T> computation)	Deprecated. Will be removed.
static <T> Future<T>	Future.ofSupplier(Executor executor, Supplier<? extends T> computation)	Deprecated. Will be removed.
static <T> Future<T>	Future.ofSupplier(Supplier<? extends T> computation)	Deprecated. Will be removed.
Future<T>	Future.onComplete(Consumer<? super Try<T>> action)	Performs the action once the Future is complete.
Future<T>	FutureImpl.onComplete(Consumer<? super Try<T>> action)
default Future<T>	Future.onFailure(Consumer<? super Throwable> action)	Performs the action once the Future is complete and the result is a Try.Failure.
default Future<T>	Future.onSuccess(Consumer<? super T> action)	Performs the action once the Future is complete and the result is a Try.Success.
default Future<T>	Future.orElse(Future<? extends T> other)
default Future<T>	Future.orElse(Supplier<? extends Future<? extends T>> supplier)
default Future<T>	Future.peek(Consumer<? super T> action)
default Future<T>	Future.recover(Function<? super Throwable, ? extends T> f)	Handles a failure of this Future by returning another result.
default Future<T>	Future.recoverWith(Function<? super Throwable, ? extends Future<? extends T>> f)	Handles a failure of this Future by returning the result of another Future.
static <T> Future<T>	Future.reduce(Iterable<? extends Future<? extends T>> futures, BiFunction<? super T, ? super T, ? extends T> f)	Returns a Future which contains the reduce result of the given future values.
static <T> Future<T>	Future.reduce(Executor executor, Iterable<? extends Future<? extends T>> futures, BiFunction<? super T, ? super T, ? extends T> f)	Returns a Future which contains the reduce result of the given future values.
static Future<Void>	Future.run(CheckedRunnable unit)	Runs an asynchronous computation, backed by the Future.DEFAULT_EXECUTOR.
static <T> Future<T>	Future.run(Task<? extends T> task)	Deprecated. Experimental API
static Future<Void>	Future.run(Executor executor, CheckedRunnable unit)	Starts an asynchronous computation, backed by the given Executor.
static <T> Future<T>	Future.run(Executor executor, Task<? extends T> task)	Deprecated. Experimental API
static Future<Void>	Future.runRunnable(Runnable computation)	Deprecated. Will be removed.
static Future<Void>	Future.runRunnable(Executor executor, Runnable computation)	Deprecated. Will be removed.
static <T> Future<Seq<T>>	Future.sequence(Iterable<? extends Future<? extends T>> futures)	Reduces many Futures into a single Future by transforming an Iterable<Future<? extends T>> into a Future<Seq<T>>.
static <T> Future<Seq<T>>	Future.sequence(Executor executor, Iterable<? extends Future<? extends T>> futures)	Reduces many Futures into a single Future by transforming an Iterable<Future<? extends T>> into a Future<Seq<T>>.
static <T> Future<T>	Future.successful(Executor executor, T result)	Creates a succeeded Future, backed by the given Executor.
static <T> Future<T>	Future.successful(T result)	Creates a succeeded Future, backed by the Future.DEFAULT_EXECUTOR.
default <U> Future<U>	Future.transformValue(Function<? super Try<T>, ? extends Try<? extends U>> f)	Transforms the value of this Future, whether it is a success or a failure.
static <T,U> Future<Seq<U>>	Future.traverse(Iterable<? extends T> values, Function<? super T, ? extends Future<? extends U>> mapper)	Maps the values of an iterable in parallel to a sequence of mapped values into a single Future by transforming an Iterable<? extends T> into a Future<Seq<U>>.
static <T,U> Future<Seq<U>>	Future.traverse(Executor executor, Iterable<? extends T> values, Function<? super T, ? extends Future<? extends U>> mapper)	Maps the values of an iterable in parallel to a sequence of mapped values into a single Future by transforming an Iterable<? extends T> into a Future<Seq<U>>.
default <U> Future<Tuple2<T,U>>	Future.zip(Future<? extends U> that)	Returns a tuple of this and that Future result.
default <U,R> Future<R>	Future.zipWith(Future<? extends U> that, BiFunction<? super T, ? super U, ? extends R> combinator)	Returns a this and that Future result combined using a given combinator function.

Methods in io.vavr.concurrent with parameters of type Future

Modifier and Type	Method	Description
default Promise<T>	Promise.completeWith(Future<? extends T> other)	Completes this Promise with the given Future, once that Future is completed.
default Future<T>	Future.fallbackTo(Future<? extends T> that)	Returns a Future that returns the result of this Future, if it is a success.
static <T> Future<T>	Future.narrow(Future<? extends T> future)	Narrows a widened Future<? extends T> to Future<T> by performing a type-safe cast.
default Future<T>	Future.orElse(Future<? extends T> other)
default Promise<T>	Promise.tryCompleteWith(Future<? extends T> other)	Attempts to complete this Promise with the specified Future, once that Future is completed.
default <U> Future<Tuple2<T,U>>	Future.zip(Future<? extends U> that)	Returns a tuple of this and that Future result.
default <U,R> Future<R>	Future.zipWith(Future<? extends U> that, BiFunction<? super T, ? super U, ? extends R> combinator)	Returns a this and that Future result combined using a given combinator function.

Method parameters in io.vavr.concurrent with type arguments of type Future

Modifier and Type	Method	Description
static <T> Future<Option<T>>	Future.find(Iterable<? extends Future<? extends T>> futures, Predicate<? super T> predicate)	Returns a Future that eventually succeeds with the first result of the given Futures which matches the given predicate.
static <T> Future<Option<T>>	Future.find(Executor executor, Iterable<? extends Future<? extends T>> futures, Predicate<? super T> predicate)	Returns a Future that eventually succeeds with the first result of the given Futures which matches the given predicate.
static <T> Future<T>	Future.firstCompletedOf(Iterable<? extends Future<? extends T>> futures)	Returns a new Future that will contain the result of the first of the given futures that is completed, backed by the Future.DEFAULT_EXECUTOR.
static <T> Future<T>	Future.firstCompletedOf(Executor executor, Iterable<? extends Future<? extends T>> futures)	Returns a new Future that will contain the result of the first of the given futures that is completed, backed by the given Executor.
default <U> Future<U>	Future.flatMap(Function<? super T, ? extends Future<? extends U>> mapper)
default <U> Future<U>	Future.flatMapTry(CheckedFunction1<? super T, ? extends Future<? extends U>> mapper)
static <T,U> Future<U>	Future.fold(Iterable<? extends Future<? extends T>> futures, U zero, BiFunction<? super U, ? super T, ? extends U> f)	Returns a Future which contains the result of the fold of the given future values.
static <T,U> Future<U>	Future.fold(Executor executor, Iterable<? extends Future<? extends T>> futures, U zero, BiFunction<? super U, ? super T, ? extends U> f)	Returns a Future which contains the result of the fold of the given future values.
default Future<T>	Future.orElse(Supplier<? extends Future<? extends T>> supplier)
default Future<T>	Future.recoverWith(Function<? super Throwable, ? extends Future<? extends T>> f)	Handles a failure of this Future by returning the result of another Future.
static <T> Future<T>	Future.reduce(Iterable<? extends Future<? extends T>> futures, BiFunction<? super T, ? super T, ? extends T> f)	Returns a Future which contains the reduce result of the given future values.
static <T> Future<T>	Future.reduce(Executor executor, Iterable<? extends Future<? extends T>> futures, BiFunction<? super T, ? super T, ? extends T> f)	Returns a Future which contains the reduce result of the given future values.
static <T> Future<Seq<T>>	Future.sequence(Iterable<? extends Future<? extends T>> futures)	Reduces many Futures into a single Future by transforming an Iterable<Future<? extends T>> into a Future<Seq<T>>.
static <T> Future<Seq<T>>	Future.sequence(Executor executor, Iterable<? extends Future<? extends T>> futures)	Reduces many Futures into a single Future by transforming an Iterable<Future<? extends T>> into a Future<Seq<T>>.
default <U> U	Future.transform(Function<? super Future<T>, ? extends U> f)	Transforms this Future.
static <T,U> Future<Seq<U>>	Future.traverse(Iterable<? extends T> values, Function<? super T, ? extends Future<? extends U>> mapper)	Maps the values of an iterable in parallel to a sequence of mapped values into a single Future by transforming an Iterable<? extends T> into a Future<Seq<U>>.
static <T,U> Future<Seq<U>>	Future.traverse(Executor executor, Iterable<? extends T> values, Function<? super T, ? extends Future<? extends U>> mapper)	Maps the values of an iterable in parallel to a sequence of mapped values into a single Future by transforming an Iterable<? extends T> into a Future<Seq<U>>.