Scala 3/API/scala.runtime

scala.runtime

package scala.runtime

Type members

Classlikes

abstract class AbstractFunction0[@specialized +R] extends () => R
abstract class AbstractFunction1[@specialized -T1, @specialized +R] extends T1 => R
abstract class AbstractFunction10[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) => R
abstract class AbstractFunction11[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11) => R
abstract class AbstractFunction12[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12) => R
abstract class AbstractFunction13[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13) => R
abstract class AbstractFunction14[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14) => R
abstract class AbstractFunction15[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15) => R
abstract class AbstractFunction16[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16) => R
abstract class AbstractFunction17[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17) => R
abstract class AbstractFunction18[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18) => R
abstract class AbstractFunction19[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19) => R
abstract class AbstractFunction2[@specialized -T1, @specialized -T2, @specialized +R] extends (T1, T2) => R
abstract class AbstractFunction20[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20) => R
abstract class AbstractFunction21[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, -T21, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21) => R
abstract class AbstractFunction22[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, -T10, -T11, -T12, -T13, -T14, -T15, -T16, -T17, -T18, -T19, -T20, -T21, -T22, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22) => R
abstract class AbstractFunction3[-T1, -T2, -T3, +R] extends (T1, T2, T3) => R
abstract class AbstractFunction4[-T1, -T2, -T3, -T4, +R] extends (T1, T2, T3, T4) => R
abstract class AbstractFunction5[-T1, -T2, -T3, -T4, -T5, +R] extends (T1, T2, T3, T4, T5) => R
abstract class AbstractFunction6[-T1, -T2, -T3, -T4, -T5, -T6, +R] extends (T1, T2, T3, T4, T5, T6) => R
abstract class AbstractFunction7[-T1, -T2, -T3, -T4, -T5, -T6, -T7, +R] extends (T1, T2, T3, T4, T5, T6, T7) => R
abstract class AbstractFunction8[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8) => R
abstract class AbstractFunction9[-T1, -T2, -T3, -T4, -T5, -T6, -T7, -T8, -T9, +R] extends (T1, T2, T3, T4, T5, T6, T7, T8, T9) => R
abstract class AbstractPartialFunction[@specialized -T1, @specialized +R] extends T1 => R with PartialFunction[T1, R]

AbstractPartialFunction reformulates all operations of its supertrait PartialFunction in terms of isDefinedAt and applyOrElse.

AbstractPartialFunction reformulates all operations of its supertrait PartialFunction in terms of isDefinedAt and applyOrElse.

This allows more efficient implementations in many cases: - optimized orElse method supports chained orElse in linear time, and with no slow-down if the orElse part is not needed. - optimized lift method helps to avoid double evaluation of pattern matchers & guards of partial function literals.

This trait is used as a basis for implementation of all partial function literals.

Source:
AbstractPartialFunction.scala
final class ArrayCharSequence(val xs: Array[Char], start: Int, end: Int) extends CharSequence
object Arrays

All but the first two operations should be short-circuited and implemented specially by the backend.

All but the first two operations should be short-circuited and implemented specially by the backend.

Source:
Arrays.scala
trait EnumValue extends Product with Serializable
trait FractionalProxy[T] extends ScalaNumberProxy[T]
trait FunctionXXL

A function with all parameters grouped in an array.

A function with all parameters grouped in an array.

Source:
FunctionXXL.scala
trait IntegralProxy[T] extends ScalaWholeNumberProxy[T] with RangedProxy[T]
final class LambdaDeserialize
object LambdaDeserialize
object LambdaDeserializer

This class is only intended to be called by synthetic $deserializeLambda$ method that the Scala 2.12 compiler will add to classes hosting lambdas.

This class is only intended to be called by synthetic $deserializeLambda$ method that the Scala 2.12 compiler will add to classes hosting lambdas.

It is not intended to be consumed directly.

Source:
LambdaDeserializer.scala
class LazyBoolean extends Serializable
class LazyByte extends Serializable
class LazyChar extends Serializable
class LazyDouble extends Serializable
class LazyFloat extends Serializable
class LazyInt extends Serializable
class LazyLong extends Serializable
class LazyRef[T] extends Serializable

Classes used as holders for lazy vals defined in methods.

Classes used as holders for lazy vals defined in methods.

Source:
LazyRef.scala
class LazyShort extends Serializable
class LazyUnit extends Serializable
object LazyVals

Helper methods used in thread-safe lazy vals.

Helper methods used in thread-safe lazy vals.

Source:
LazyVals.scala
final abstract class MatchCase[Pat, +Body]

A type constructor for a case in a match type.

A type constructor for a case in a match type.

Source:
MatchCase.scala
@nowarn("cat=lint-unit-specialization")
class NonLocalReturnControl[@specialized(Byte, Short, Int, Long, Char, Float, Double, Boolean, Unit) T](val key: AnyRef, val value: T) extends ControlThrowable
sealed abstract class Nothing$ extends Throwable

Dummy class which exist only to satisfy the JVM.

Dummy class which exist only to satisfy the JVM. It corresponds to scala.Nothing. If such type appears in method signatures, it is erased to this one.

Source:
Nothing$.scala
sealed abstract class Null$

Dummy class which exist only to satisfy the JVM.

Dummy class which exist only to satisfy the JVM. It corresponds to scala.Null. If such type appears in method signatures, it is erased to this one. A private constructor ensures that Java code can't create subclasses. The only value of type Null$ should be null

Source:
Null$.scala
@nowarn("cat=deprecation")
trait OrderedProxy[T] extends Ordered[T] with Typed[T]
@nowarn("cat=deprecation")
trait RangedProxy[T] extends Typed[T]
final class RichBoolean(val self: Boolean) extends AnyVal with OrderedProxy[Boolean]
final class RichByte(val self: Byte) extends AnyVal with ScalaWholeNumberProxy[Byte]
final class RichChar(val self: Char) extends AnyVal with IntegralProxy[Char]
final class RichDouble(val self: Double) extends AnyVal with FractionalProxy[Double]
final class RichFloat(val self: Float) extends AnyVal with FractionalProxy[Float]
final class RichInt(val self: Int) extends AnyVal with ScalaNumberProxy[Int] with RangedProxy[Int]
final class RichLong(val self: Long) extends AnyVal with IntegralProxy[Long]
final class RichShort(val self: Short) extends AnyVal with ScalaWholeNumberProxy[Short]
object Scala3RunTime
@nowarn("cat=deprecation")
trait ScalaNumberProxy[T] extends ScalaNumericAnyConversions with Typed[T] with OrderedProxy[T]

Base classes for the Rich* wrappers of the primitive types.

Base classes for the Rich* wrappers of the primitive types. As with all classes in scala.runtime.*, this is not a supported API.

Source:
ScalaNumberProxy.scala
object ScalaRunTime

The object ScalaRunTime provides support methods required by the scala runtime.

The object ScalaRunTime provides support methods required by the scala runtime. All these methods should be considered outside the API and subject to change or removal without notice.

Source:
ScalaRunTime.scala
trait ScalaWholeNumberProxy[T] extends ScalaNumberProxy[T]
final class StructuralCallSite
object StructuralCallSite
final class TupleXXL extends Product
Companion:
object
Source:
TupleXXL.scala
object TupleXXL
Companion:
class
Source:
TupleXXL.scala
object Tuples
final abstract class TypeBox[-L <: U, +U]

A type for skolems that are generated during capture conversion.

A type for skolems that are generated during capture conversion. Capture conversion narrows the type of a tree whose type has wildcard arguments. A typical situation is a tree t of type C[_ >: L <: U] and an expected type C[X] where X is an instantiatable type variable. To be able to instantiate X, we cast the tree to type X[$n.CAP] where $n is a fresh skolem type with underlying type TypeBox[L, U].

Source:
TypeBox.scala

Deprecated classlikes

@deprecated("Use scala.collection.LazyZip2.", "2.13.0")
final class Tuple2Zipped[El1, It1 <: Iterable[El1], El2, It2 <: Iterable[El2]](colls: (It1, It2)) extends AnyVal with ZippedIterable2[El1, El2]
Companion:
object
Deprecated
Source:
Tuple2Zipped.scala
@deprecated("Use scala.collection.LazyZip2.", since = "2.13.0")
object Tuple2Zipped
Companion:
class
Deprecated
[Since version 2.13.0]
Source:
Tuple2Zipped.scala
@deprecated("Use scala.collection.LazyZip3.", "2.13.0")
final class Tuple3Zipped[El1, It1 <: Iterable[El1], El2, It2 <: Iterable[El2], El3, It3 <: Iterable[El3]](colls: (It1, It2, It3)) extends AnyVal with ZippedIterable3[El1, El2, El3]
Companion:
object
Deprecated
Source:
Tuple3Zipped.scala
@deprecated("Use scala.collection.LazyZip3.", since = "2.13.0")
object Tuple3Zipped
Companion:
class
Deprecated
[Since version 2.13.0]
Source:
Tuple3Zipped.scala
@deprecated("Use scala.collection.LazyZip2.", "2.13.0")
trait ZippedIterable2[+El1, +El2]

This interface is intended as a minimal interface, not complicated by the requirement to resolve type constructors, for implicit search (which only needs to find an implicit conversion to Iterable for our purposes.)

This interface is intended as a minimal interface, not complicated by the requirement to resolve type constructors, for implicit search (which only needs to find an implicit conversion to Iterable for our purposes.)

Companion:
object
Deprecated
Source:
Tuple2Zipped.scala
@deprecated("Use scala.collection.LazyZip2.", "2.13.0")
object ZippedIterable2
Companion:
class
Deprecated
Source:
Tuple2Zipped.scala
@deprecated("Use scala.collection.LazyZip3.", "2.13.0")
trait ZippedIterable3[+El1, +El2, +El3]

See comment on ZippedIterable2

See comment on ZippedIterable2

Companion:
object
Deprecated
Source:
Tuple3Zipped.scala
@deprecated("Use scala.collection.LazyZip3.", "2.13.0")
object ZippedIterable3
Companion:
class
Deprecated
Source:
Tuple3Zipped.scala

Types

infix type $throws[R, +E <: Exception] = CanThrow[E] => R

A helper type to allow syntax like

A helper type to allow syntax like

def f(): T throws Ex1 | Ex2

Used in desugar.throws.

Source:
$throws.scala