Future

Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.
Test two objects for inequality.
returns
true if !(this == that), false otherwise.

Definition Classes
AnyRef → Any
final def ##(): Int

Equivalent to x.hashCode except for boxed numeric types and null.
Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.
returns
a hash value consistent with ==

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def apply[T](body: ⇒ T)(implicit executor: ExecutionContext): Future[T]

Starts an asynchronous computation and returns a Future instance with the result of that computation.
Starts an asynchronous computation and returns a Future instance with the result of that computation.
The result becomes available once the asynchronous computation is completed.
T
the type of the result
body
the asynchronous computation
executor
the execution context on which the future is run
returns
the Future holding the result of the computation
final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.
returns
the receiver object.

Definition Classes
Any
Exceptions thrown
ClassCastException if the receiver object is not an instance of the erasure of type T0.
def clone(): AnyRef

Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
Note
not specified by SLS as a member of AnyRef
final def eq(arg0: AnyRef): Boolean

Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:
- It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
- For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
- null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
returns
true if the argument is a reference to the receiver object; false otherwise.

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

The equality method for reference types.
The equality method for reference types. Default implementation delegates to eq.
See also equals in scala.Any.
returns
true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
AnyRef → Any
def failed[T](exception: Throwable): Future[T]

Creates an already completed Future with the specified exception.
Creates an already completed Future with the specified exception.
T
the type of the value in the future
exception
the non-null instance of Throwable
returns
the newly created Future instance
def finalize(): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
Note
not specified by SLS as a member of AnyRef
def find[T](futures: collection.immutable.Iterable[Future[T]])(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[Option[T]]

Asynchronously and non-blockingly returns a Future that will hold the optional result of the first Future with a result that matches the predicate, failed Futures will be ignored.
Asynchronously and non-blockingly returns a Future that will hold the optional result of the first Future with a result that matches the predicate, failed Futures will be ignored.
T
the type of the value in the future
futures
the scala.collection.immutable.Iterable of Futures to search
p
the predicate which indicates if it's a match
returns
the Future holding the optional result of the search
def firstCompletedOf[T](futures: TraversableOnce[Future[T]])(implicit executor: ExecutionContext): Future[T]

Asynchronously and non-blockingly returns a new Future to the result of the first future in the list that is completed.
Asynchronously and non-blockingly returns a new Future to the result of the first future in the list that is completed. This means no matter if it is completed as a success or as a failure.
T
the type of the value in the future
futures
the TraversableOnce of Futures in which to find the first completed
returns
the Future holding the result of the future that is first to be completed
def foldLeft[T, R](futures: collection.immutable.Iterable[Future[T]])(zero: R)(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

A non-blocking, asynchronous left fold over the specified futures, with the start value of the given zero.
A non-blocking, asynchronous left fold over the specified futures, with the start value of the given zero. The fold is performed asynchronously in left-to-right order as the futures become completed. The result will be the first failure of any of the futures, or any failure in the actual fold, or the result of the fold.
Example:
```
val futureSum = Future.foldLeft(futures)(0)(_ + _)
```
T
the type of the value of the input Futures
R
the type of the value of the returned Future
futures
the scala.collection.immutable.Iterable of Futures to be folded
zero
the start value of the fold
op
the fold operation to be applied to the zero and futures
returns
the Future holding the result of the fold
def fromTry[T](result: Try[T]): Future[T]

Creates an already completed Future with the specified result or exception.
Creates an already completed Future with the specified result or exception.
T
the type of the value in the Future
result
the result of the returned Future instance
returns
the newly created Future instance
final def getClass(): Class[_]

A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.

Definition Classes
AnyRef → Any
Note
not specified by SLS as a member of AnyRef
def hashCode(): Int

The hashCode method for reference types.
The hashCode method for reference types. See hashCode in scala.Any.
returns
the hash code value for this object.

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Equivalent to !(this eq that).
Equivalent to !(this eq that).
returns
true if the argument is not a reference to the receiver object; false otherwise.

Definition Classes
AnyRef
object never extends Future[Nothing]

A Future which is never completed.
final def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.

Definition Classes
AnyRef
Note
not specified by SLS as a member of AnyRef
def reduceLeft[T, R >: T](futures: collection.immutable.Iterable[Future[T]])(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

Initiates a non-blocking, asynchronous, left reduction over the supplied futures where the zero is the result value of the first Future.
Initiates a non-blocking, asynchronous, left reduction over the supplied futures where the zero is the result value of the first Future.
Example:
```
val futureSum = Future.reduceLeft(futures)(_ + _)
```
T
the type of the value of the input Futures
R
the type of the value of the returned Future
futures
the scala.collection.immutable.Iterable of Futures to be reduced
op
the reduce operation which is applied to the results of the futures
returns
the Future holding the result of the reduce
def sequence[A, M[X] <: TraversableOnce[X]](in: M[Future[A]])(implicit cbf: CanBuildFrom[M[Future[A]], A, M[A]], executor: ExecutionContext): Future[M[A]]

Simple version of Future.traverse.
Simple version of Future.traverse. Asynchronously and non-blockingly transforms a TraversableOnce[Future[A]] into a Future[TraversableOnce[A]]. Useful for reducing many Futures into a single Future.
A
the type of the value inside the Futures
M
the type of the TraversableOnce of Futures
in
the TraversableOnce of Futures which will be sequenced
returns
the Future of the TraversableOnce of results
def successful[T](result: T): Future[T]

Creates an already completed Future with the specified result.
Creates an already completed Future with the specified result.
T
the type of the value in the future
result
the given successful value
returns
the newly created Future instance
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
returns
a String representation of the object.

Definition Classes
AnyRef → Any
def traverse[A, B, M[X] <: TraversableOnce[X]](in: M[A])(fn: (A) ⇒ Future[B])(implicit cbf: CanBuildFrom[M[A], B, M[B]], executor: ExecutionContext): Future[M[B]]

Asynchronously and non-blockingly transforms a TraversableOnce[A] into a Future[TraversableOnce[B]] using the provided function A => Future[B].
Asynchronously and non-blockingly transforms a TraversableOnce[A] into a Future[TraversableOnce[B]] using the provided function A => Future[B]. This is useful for performing a parallel map. For example, to apply a function to all items of a list in parallel:
```
val myFutureList = Future.traverse(myList)(x => Future(myFunc(x)))
```
A
the type of the value inside the Futures in the TraversableOnce
B
the type of the value of the returned Future
M
the type of the TraversableOnce of Futures
in
the TraversableOnce of Futures which will be sequenced
fn
the function to apply to the TraversableOnce of Futures to produce the results
returns
the Future of the TraversableOnce of results
val unit: Future[Unit]

A Future which is always completed with the Unit value.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def find[T](futures: TraversableOnce[Future[T]])(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[Option[T]]

Asynchronously and non-blockingly returns a Future that will hold the optional result of the first Future with a result that matches the predicate.
Asynchronously and non-blockingly returns a Future that will hold the optional result of the first Future with a result that matches the predicate.
T
the type of the value in the future
futures
the TraversableOnce of Futures to search
p
the predicate which indicates if it's a match
returns
the Future holding the optional result of the search

Annotations
@deprecated
Deprecated
(Since version 2.12) Use the overloaded version of this method that takes a scala.collection.immutable.Iterable instead
def fold[T, R](futures: TraversableOnce[Future[T]])(zero: R)(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

A non-blocking, asynchronous fold over the specified futures, with the start value of the given zero.
A non-blocking, asynchronous fold over the specified futures, with the start value of the given zero. The fold is performed on the thread where the last future is completed, the result will be the first failure of any of the futures, or any failure in the actual fold, or the result of the fold.
Example:
```
val futureSum = Future.fold(futures)(0)(_ + _)
```
T
the type of the value of the input Futures
R
the type of the value of the returned Future
futures
the TraversableOnce of Futures to be folded
zero
the start value of the fold
op
the fold operation to be applied to the zero and futures
returns
the Future holding the result of the fold

Annotations
@deprecated
Deprecated
(Since version 2.12) Use Future.foldLeft instead
def reduce[T, R >: T](futures: TraversableOnce[Future[T]])(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

Initiates a non-blocking, asynchronous, fold over the supplied futures where the fold-zero is the result value of the Future that's completed first.
Initiates a non-blocking, asynchronous, fold over the supplied futures where the fold-zero is the result value of the Future that's completed first.
Example:
```
val futureSum = Future.reduce(futures)(_ + _)
```
T
the type of the value of the input Futures
R
the type of the value of the returned Future
futures
the TraversableOnce of Futures to be reduced
op
the reduce operation which is applied to the results of the futures
returns
the Future holding the result of the reduce

Annotations
@deprecated
Deprecated
(Since version 2.12) Use Future.reduceLeft instead

Related Docs: trait Future | package concurrent

object Future

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[T](body: ⇒ T)(implicit executor: ExecutionContext): Future[T]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def failed[T](exception: Throwable): Future[T]

def finalize(): Unit

def find[T](futures: collection.immutable.Iterable[Future[T]])(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[Option[T]]

def firstCompletedOf[T](futures: TraversableOnce[Future[T]])(implicit executor: ExecutionContext): Future[T]

def foldLeft[T, R](futures: collection.immutable.Iterable[Future[T]])(zero: R)(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

def fromTry[T](result: Try[T]): Future[T]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

object never extends Future[Nothing]

final def notify(): Unit

final def notifyAll(): Unit

def reduceLeft[T, R >: T](futures: collection.immutable.Iterable[Future[T]])(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

def sequence[A, M[X] <: TraversableOnce[X]](in: M[Future[A]])(implicit cbf: CanBuildFrom[M[Future[A]], A, M[A]], executor: ExecutionContext): Future[M[A]]

def successful[T](result: T): Future[T]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def traverse[A, B, M[X] <: TraversableOnce[X]](in: M[A])(fn: (A) ⇒ Future[B])(implicit cbf: CanBuildFrom[M[A], B, M[B]], executor: ExecutionContext): Future[M[B]]

val unit: Future[Unit]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def find[T](futures: TraversableOnce[Future[T]])(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[Option[T]]

def fold[T, R](futures: TraversableOnce[Future[T]])(zero: R)(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

def reduce[T, R >: T](futures: TraversableOnce[Future[T]])(op: (R, T) ⇒ R)(implicit executor: ExecutionContext): Future[R]

Inherited from AnyRef

Inherited from Any

Ungrouped