Spec-Zone.ru › Scala 2.13 Library

Объект scala.concurrent.Future

Компаньон трейт Future

объект Future

Объект-компаньон Future.

Источник
Future.scala
Линейные супертипы
AnyRef, Any

Члены-значения

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

возвращает

true если !(this == that), в противном случае false.

Определяющие классы
AnyRef → Any

final def ##(): Int

Эквивалентно x.hashCode за исключением упакованных числовых типов и null. Для чисел возвращает значение хэша, согласованное с равенством значений: если два экземпляра типа значения сравниваются как true, то ## вернёт одно и то же значение хэша для каждого из них. Для null возвращает хэш-код, где null.hashCode вызывает NullPointerException.

возвращает

значение хэша, согласованное с ==

Определяющие классы
AnyRef → Any

final def ==(arg0: Any): Boolean

Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

возвращает

true если объект-получатель эквивалентен аргументу; false в противном случае.

Определяющие классы
AnyRef → Any

final def apply[T](body: => T)(implicit executor: ExecutionContext): Future[T]

Запускает асинхронное вычисление и возвращает экземпляр Future с результатом этого вычисления.

Следующие выражения эквивалентны:

val f1 = Future(expr)
val f2 = Future.unit.map(_ => expr)
val f3 = Future.unit.transform(_ => Success(expr))

Результат становится доступен после завершения асинхронного вычисления.

T

тип результата

body

асинхронное вычисление

executor

контекст выполнения, в котором выполняется задача

возвращает

экземпляр Future, содержащий результат вычисления

final def asInstanceOf[T0]: T0

Приводит объект-получатель к типу T0.

Обратите внимание, что успех приведения типов во время выполнения определяется семантикой стирания Scala. Следовательно, выражение 1.asInstanceOf[String] выбросит ClassCastException во время выполнения, в то время как выражение List(1).asInstanceOf[List[String]] этого не сделает. В последнем примере, поскольку тип аргумента стирается во время компиляции, невозможно проверить, относятся ли содержимое списка к запрошенному типу.

возвращает

объект-получатель.

Определяющие классы
Any
Исключения

ClassCastException если объект-получатель не является экземпляром стирания типа T0.

def clone(): AnyRef

Создаёт копию объекта-получателя.

По умолчанию реализация метода clone зависит от платформы.

возвращает

копию объекта-получателя.

Атрибуты
protected[java.lang]
Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Примечание

не специфицировано SLS как член AnyRef

final def delegate[T](body: => Future[T])(implicit executor: ExecutionContext): Future[T]

Запускает асинхронное вычисление и возвращает экземпляр Future с результатом вычисления по завершении.

Следующие выражения семантически эквивалентны:

val f1 = Future(expr).flatten
val f2 = Future.delegate(expr)
val f3 = Future.unit.flatMap(_ => expr)

Результат становится доступен по завершении результата асинхронного вычисления.

T

тип результата

body

асинхронное вычисление, возвращающее Future

executor

контекст выполнения, в котором вычисляется body

возвращает

экземпляр Future, содержащий результат вычисления

final def eq(arg0: AnyRef): Boolean

Проверяет, является ли аргумент (that) ссылкой на объект-получатель (this).

Метод eq реализует отношение эквивалентности на не-нулевых экземплярах AnyRef, и обладает тремя дополнительными свойствами:

    Он согласован: для любых не-нулевых экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false.Для любого не-нулевого экземпляра x типа AnyRef, x.eq(null) и null.eq(x) возвращают false. null.eq(null) возвращает true.

При переопределении методов equals или hashCode важно обеспечить согласованность их поведения с равенством ссылок. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2 ), они должны быть равны друг другу (o1 == o2 ) и должны хешироваться до одного и того же значения (o1.hashCode == o2.hashCode).

возвращает

true если аргумент является ссылкой на объект-получатель; false в противном случае.

Определяющие классы
AnyRef

def equals(arg0: AnyRef): Boolean

Метод равенства для ссылочных типов. Реализация по умолчанию делегирует eq.

См. также equals в scala.Any.

returns

true если принимающий объект эквивалентен аргументу; false в противном случае.

Определяющие классы
AnyRef → Any

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

Создает уже завершенный Future с указанным исключением.

T

тип значения в будущем

exception

не null экземпляр Throwable

returns

недавно созданный экземпляр Future

def finalize(): Unit

Вызывается сборщиком мусора для принимающего объекта, когда больше нет ссылок на объект.

Подробности о том, когда и будет ли вызван метод finalize, а также взаимодействие между finalize и нелокальными возвратами и исключениями, зависят от платформы.

Атрибуты
protected[java.lang]
Определяющие классы
AnyRef
Аннотации
@throws(classOf[java.lang.Throwable])
Примечание

не указано в SLS как член AnyRef

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

Асинхронно и без блокировки возвращает Future, который будет содержать необязательный результат первого Future с результатом, соответствующим предикату; неудачные Future будут игнорироваться.

T

тип значения в будущем

futures

scala.collection.immutable.Iterable Futures для поиска

p

предикат, указывающий, является ли это совпадением

returns

Future содержащий необязательный результат поиска

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

Асинхронно и без блокировки возвращает новый Future результата первого будущего в списке, который завершен. Это означает, независимо от того, завершен ли он как успех или как сбой.

T

тип значения в будущем

futures

IterableOnce Futures, в котором нужно найти первый завершенный

returns

Future содержащий результат будущего, который первым завершается

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

Неблокирующее, асинхронное левое сворачивание заданных futures, с начальным значением заданного zero. Сворачивание выполняется асинхронно слева направо по мере завершения futures. Результатом будет первая ошибка любого из futures, любая ошибка в фактическом сворачивании или результат сворачивания.

Пример:

val futureSum = Future.foldLeft(futures)(0)(_ + _)
T

тип значения входных Futures

R

тип значения возвращаемого Future

futures

scala.collection.immutable.Iterable Futures, которые нужно свернуть

zero

начальное значение сворачивания

op

операция сворачивания, которая должна быть применена к zero и futures

returns

Future содержащий результат сворачивания

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

Создает уже завершенный Future с указанным результатом или исключением.

T

тип значения в Future

result

результат возвращаемого экземпляра Future

returns

недавно созданный экземпляр Future

final def getClass(): Class[_ <: AnyRef]

Возвращает представление класса во время выполнения объекта.

returns

объект класса, соответствующий времени выполнения типа приемника.

Определяющие классы
AnyRef → Any
Аннотации
@native()

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

returns

хеш-код для этого объекта.

Определяющие классы
AnyRef → Any
Аннотации
@native()

final def isInstanceOf[T0]: Boolean

Проверяет, является ли динамический тип объекта получателя T0.

Обратите внимание, что результат теста зависит от семантики стирания типов в Scala. Поэтому выражение 1.isInstanceOf[String] вернет false, а выражение List(1).isInstanceOf[List[String]] вернет true. Во втором примере, поскольку параметр типа стирается во время компиляции, проверить, соответствуют ли содержимое списка указанному типу, невозможно.

returns

true если объект получатель является экземпляром стирания типа T0; false в противном случае.

Определяющие классы
Any

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

returns

true если аргумент не является ссылкой на объект получатель; false в противном случае.

Определяющие классы
AnyRef

final def notify(): Unit

Разбуждает один поток, ожидающий на мониторе объекта получателя.

Определяющие классы
AnyRef
Аннотации
@native()
Примечание

не указан в SLS как член AnyRef

final def notifyAll(): Unit

Разбуждает все потоки, ожидающие на мониторе объекта получателя.

Определяющие классы
AnyRef
Аннотации
@native()
Примечание

не указан в SLS как член AnyRef

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

Инициирует неблокирующую, асинхронную, левую редукцию над предоставленными futures, где нулевым значением является результирующее значение первого Future.

Пример:

val futureSum = Future.reduceLeft(futures)(_ + _)
T

тип значения входных Futures

R

тип значения возвращаемого Future

futures

scala.collection.immutable.Iterable Futures, которые будут редуцированы

op

операция редукции, которая применяется к результатам futures

returns

Future содержащий результат редукции

final def sequence[A, CC[X] <: IterableOnce[X], To](in: CC[Future[A]])(implicit bf: BuildFrom[CC[Future[A]], A, To], executor: ExecutionContext): Future[To]

Простая версия Future.traverse. Асинхронно и неблокирующе преобразует, по сути, IterableOnce[Future[A]] в Future[IterableOnce[A]]. Полезно для редукции многих Future в один Future.

A

тип значения внутри Futures

CC

тип IterableOnce Futures

To

тип результирующей коллекции

in

IterableOnce Futures, которые будут обработаны

returns

Future результирующей коллекции

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

Создает уже завершенный Future с указанным результатом.

T

тип значения в future

result

указанное успешное значение

returns

недавно созданный экземпляр Future

final def synchronized[T0](arg0: => T0): T0

Определяющие классы
AnyRef

def toString(): String

Создаёт строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java это конкатенация имени класса, «@» и хэш-кода объекта в шестнадцатеричном формате.

returns

строковое представление объекта.

Definition Classes
AnyRef → Any

final def traverse[A, B, M[X] <: IterableOnce[X]](in: M[A])(fn: (A) => Future[B])(implicit bf: BuildFrom[M[A], B, M[B]], executor: ExecutionContext): Future[M[B]]

Асинхронно и без блокировок преобразует IterableOnce[A] в Future[IterableOnce[B]] с использованием предоставленной функции A => Future[B]. Это полезно для выполнения параллельного применения. Например, чтобы применить функцию ко всем элементам списка параллельно:

val myFutureList = Future.traverse(myList)(x => Future(myFunc(x)))
A

тип значения внутри Future в коллекции

B

тип значения возвращаемой Future

M

тип коллекции Futures

in

коллекция, по которой будет выполнено отображение с предоставленной функцией для создания коллекции Futures, которая затем последовательно сгруппируется в коллекцию Future

fn

функция, которая будет применена к коллекции для создания коллекции Futures

returns

Future результат отображения коллекции результатов

final val unit: Future[Единица]

final def wait(): Единица

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Единица

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Единица

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

object never extends Future[Nothing]

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/concurrent/Future$.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API