Spec-Zone.ru › Scala 2.12 Library

Объект scala.concurrent.Future

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

объект Future

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

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

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

final def !=(arg0: Any): Boolean

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

returns

true если !(this == that), иначе false.

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

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

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

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

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

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

T

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

body

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

executor

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

returns

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

final def asInstanceOf[T0]: T0

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

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

returns

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

Definition Classes
Any
Исключения

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

def clone(): AnyRef

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

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

returns

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

Attributes
protected[lang]
Definition Classes
AnyRef
Аннотации
@throws( ... ) @native()
Примечание

не определено SLS как член AnyRef

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).

returns

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

Definition Classes
AnyRef

def equals(arg0: Any): Boolean

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

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

returns

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

Definition Classes
AnyRef → Any

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

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

T

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

exception

не-нулевой экземпляр Throwable

returns

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

def finalize(): Unit

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

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

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

не определен SLS как член AnyRef

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

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

T

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

futures

набор Futures для поиска

p

предикат, определяющий соответствие

returns

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

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

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

T

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

futures

набор Futures, в котором найти первое завершенное

returns

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

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

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

Пример:

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

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

R

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

futures

набор Futures для fold

zero

начальное значение fold

op

операция fold, применяемая к zero и futures

returns

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

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

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

T

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

result

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

returns

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

final def getClass(): Class[_]

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

returns

объект класса, соответствующий типу runtime получателя.

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

def hashCode(): Int

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

returns

значение hash-кода для этого объекта.

Определяющие классы
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).

возвращает

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

Классы-определения
AnyRef

final def notify(): Unit

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

Классы-определения
AnyRef
Аннотации
@native()
Примечание

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

final def notifyAll(): Unit

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

Классы-определения
AnyRef
Аннотации
@native()
Примечание

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

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

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

Пример:

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

тип значения входных фьючерсов

R

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

futures

список фьючерсов для редукции

op

операция редукции, применяемая к результатам фьючерсов

возвращает

фьючерс, содержащий результат редукции

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]]

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

A

тип значения внутри фьючерсов

M

тип TraversableOnce фьючерсов

in

список фьючерсов, которые будут упорядочены

возвращает

список результатов

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

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

T

тип значения в фьючерсе

result

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

возвращает

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

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

Классы-определения
AnyRef

def toString(): String

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

возвращает

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

Классы-определения
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]]

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

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

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

B

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

M

тип TraversableOnce Futures

in

TraversableOnce Futures, которые будут последовательно обработаны

fn

функция для применения к TraversableOnce Futures для получения результатов

returns

Future TraversableOnce результатов

val unit: Future[Unit]

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( ... ) @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.12.9/scala/concurrent/Future$.html

Spec-Zone.ru

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