Types

tastyquery.Types$

object Types

Types in the Scala type system.

Every type from the Scala type system is represented in tasty-query as an instance of Type. That abstract class has a number of subtypes for all the possible "shapes" of types.

For example, a reference to the class scala.Int is represented as

TypeRef(PackageRef("scala"), TypeName("Int"))

Type applications of the form C[T1, ..., Tn] are represented as

AppliedType(typeForC, List(typeForT1, ..., typeForTn))

etc.

The full hierarchy is organized as follows:

Type
|
+- WildcardTypeBounds         `? >: L <: H`
|
+- TermType                   a type that can be the type of a term tree
   |
   +- PackageRef              a reference to a package (typically used as `prefix` of `NamedType`s)
   |
   +- MethodicType            types of methods
   |  +- MethodType           `(termParams): resultType`
   |  +- PolyType             `[TypeParams]: resultType`
   |
   +- ValueType               a type that can be the type of a run-time value or type lambda,
      |                       i.e., what the spec calls a regular *type*
      +- NamedType
      |  +- TypeRef           type selection of the form `prefix.T`
      |  +- TermRef           term selection of the form `prefix.t`
      +- AppliedType          `C[T1, ..., Tn]`
      +- ByNameType            type of a by-name parameter `=> T`
      +- ThisType             `C.this`
      +- OrType               `A | B`
      +- AndType              `A & B`
      +- TypeLambda           `[T1, ..., Tn] => R`
      +- TypeParamRef         reference to a type parameter of an enclosing `TypeLambda` or `PolyType`
      +- TermParamRef         reference to a term parameter of an enclosing `MethodType`
      +- AnnotatedType        `T @annotation`
      +- ConstantType         literal singleton type, such as `42` or `"foo"`
      +- MatchType            `T match { case ... }`
      +- RefinedType
      |  +- TypeRefinement    `P { type T >: L <: H }`
      |  +- TermRefinement    `P { val/def t: T }`
      +- RecType              recursive type that introduces a recursive `this` binding
      +- RecThis              recursive reference to the `this` of a `RecType`
      +- SuperType            `super[mix]` (typically used as `prefix` of `NamedType`s)

Common shapes of types can be constructed with properties of Symbols.Symbol and with combinator methods on Type:

typeSymbol.staticRef constructs a TypeRef to the given static typeSymbol
termSymbol.staticRef constructs a TermRef to the given static termSymbol
tpe1.appliedTo(tpe2) constructs the application tpe1[tpe2] (there is an overload that accepts a list of type arguments)
tpe1 | tpe2 constructs a union type
tpe1 & tpe2 constructs an intersection type

Attributes

Graph
Supertypes: class Object

trait Matchable

class Any
Self type: Types.type

Members list

Type members

Classlikes

Attributes

Companion: object
Supertypes: trait ValueType

trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: AndType.type

typ @ annot

Attributes

Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

A type application C[T_1, ..., T_n] Typebounds for wildcard application: C[_], C[?]

Attributes

Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Encapsulates the binders associated with a ParamRef.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait ParamRefBinders

trait LambdaType

trait TermLambdaType

class MethodType

trait TypeLambdaType

class PolyType

class TypeLambda

trait TypeBinders

class MatchTypeCase

class RecType
Show all

Attributes

Supertypes: class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: trait ParamRef

class TermParamRef

class TypeParamRef

class RecThis

A by-name parameter type of the form => T.

Attributes

Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

A constant type with single value.

Attributes

Supertypes: trait SingletonType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Superclass for custom transient ground types used by custom algorithms.

When writing algorithms that manipulate Types, it is sometimes useful to temporarily store custom data in place of Types. This can be done by defining a subclass of CustomTransientGroundType. At the end of the day, all CustomTransientGroundTypes should have been replaced by proper Types.

The methods of tasty-query never expose instances of CustomTransientGroundType, but you may use it for your own purposes.

When permorming an exhaustive match on all possible Types, you should cover CustomTransientGroundType in a case that always throws (unless you are actually using it for some purposes):

val tpe: Type = ...
tpe match
 case tpe: TypeRef => ...
 ...
 case tpe: CustomTransientGroundType =>
   throw AssertionError(s"Unexpected custom transient ground type $tpe")
end match

Attributes

Supertypes: class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: enum
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: ErasedTypeRef.type

Non-proxy types

Attributes

Supertypes: class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class AndType

class CustomTransientGroundType

trait MethodicType

class MethodType

class PolyType

class OrType

class PackageRef

class TypeLambda
Show all

Attributes

Supertypes: trait TermType

trait ParamRefBinders

trait Binders

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: trait TermLambdaType

class MethodType

trait TypeLambdaType

class PolyType

class TypeLambda

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object MethodType.type

class TypeLambdaTypeCompanion[LT]

object PolyType.type

object TypeLambda.type

selector match { cases }

Attributes

Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

case pattern => result

Attributes

Companion: object
Supertypes: trait TypeBinders

trait ParamRefBinders

trait Binders

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: MatchTypeCase.type

Attributes

Companion: object
Supertypes: trait TermLambdaType

trait LambdaType

trait ParamRefBinders

trait Binders

trait MethodicType

trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class LambdaTypeCompanion[TermName, Type, MethodType]

class Object

trait Matchable

class Any
Self type: MethodType.type

The type of a def that has at least one (term or type) parameter list.

Partitioned into MethodType and PolyType.

Attributes

Supertypes: trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class MethodType

class PolyType

Attributes

Companion: object
Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class TermRef

class TypeRef

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: NamedType.type

Attributes

Supertypes: class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Self type: NoPrefix.type

Attributes

Companion: object
Supertypes: trait ValueType

trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: OrType.type

Attributes

Supertypes: trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait BoundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class TermParamRef

class TypeParamRef

Attributes

Supertypes: trait Binders

class Object

trait Matchable

class Any
Known subtypes: trait LambdaType

trait TermLambdaType

class MethodType

trait TypeLambdaType

class PolyType

class TypeLambda

trait TypeBinders

class MatchTypeCase
Show all

Attributes

Companion: object
Supertypes: trait TypeLambdaType

trait TypeBinders

trait LambdaType

trait ParamRefBinders

trait Binders

trait MethodicType

trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class TypeLambdaTypeCompanion[PolyType]

class LambdaTypeCompanion[TypeName, TypeBounds, PolyType]

class Object

trait Matchable

class Any
Self type: PolyType.type

Attributes

Supertypes: trait TypeMappable

class Object

trait Matchable

class Any
Known subtypes: object NoPrefix.type

class Type

trait BoundType

trait ParamRef

class TermParamRef

class TypeParamRef

class RecThis

class GroundType

class AndType

class CustomTransientGroundType

trait MethodicType

class MethodType

class PolyType

class OrType

class PackageRef

class TypeLambda

trait TermType

trait LambdaType

trait TermLambdaType

trait TypeLambdaType

trait ValueType

class AnnotatedType

class AppliedType

class ByNameType

class MatchType

class NamedType

class TermRef

class TypeRef

class RefinedOrRecType

class RecType

class RefinedType

class TermRefinement

class TypeRefinement

trait SingletonType

class ConstantType

class SkolemType

class SuperType

class ThisType

class TypeProxy

class WildcardTypeBounds
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class TypeBounds

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait SingletonType

trait ValueType

trait TermType

trait BoundType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: object
Supertypes: trait Binders

class RefinedOrRecType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: RecType.type

Attributes

Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class RecType

class RefinedType

class TermRefinement

class TypeRefinement

Attributes

Supertypes: class RefinedOrRecType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class TermRefinement

class TypeRefinement

A marker trait for types that are guaranteed to contain only a single non-null value (they might contain null in addition).

Attributes

Supertypes: trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class ConstantType

class RecThis

class SkolemType

class SuperType

class TermParamRef

class TermRef

class ThisType
Show all

A skolem type reference with underlying type tpe.

For tasty-query, a skolem type is a singleton type of some unknown value of type tpe.

Skolem types do not appear as the types of trees or symbols, but they may be used internally, notably for subtyping and member lookup purposes.

Note that care is needed when creating them, since not all types need to be inhabited.

A skolem is equal to itself and no other type.

Attributes

Supertypes: trait SingletonType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

The type of a super reference cls.super where thistpe is cls.this and supertpe is the type of the value referenced by super.

Attributes

Supertypes: trait SingletonType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait LambdaType

trait TermType

trait ParamRefBinders

trait Binders

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class MethodType

Attributes

Supertypes: trait SingletonType

trait ValueType

trait TermType

trait ParamRef

trait BoundType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

The singleton type for path prefix#myDesignator.

Attributes

Companion: object
Supertypes: trait SingletonType

class NamedType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: TermRef.type

A term refinement parent { val/def refinedName: refinedType }.

Value parameters

parent: The type being refined
refinedName: The name of the refined term member
refinedType: The refined type for the given term member

Attributes

Supertypes: class RefinedType

class RefinedOrRecType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

A marker trait for types that can be the type of a Trees.TermTree.

The only standard Type that is not a TermType is WildcardTypeBounds.

Partitioned into ValueType, MethodicType and PackageRef.

Attributes

Supertypes: class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: trait LambdaType

trait TermLambdaType

class MethodType

trait TypeLambdaType

class PolyType

class TypeLambda

trait MethodicType

class PackageRef

trait ValueType

class AndType

class AnnotatedType

class AppliedType

class ByNameType

class MatchType

class NamedType

class TermRef

class TypeRef

class OrType

class RefinedOrRecType

class RecType

class RefinedType

class TermRefinement

class TypeRefinement

trait SingletonType

class ConstantType

class RecThis

class SkolemType

class SuperType

class TermParamRef

class ThisType

class TypeParamRef
Show all

Attributes

Supertypes: trait SingletonType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

A type in the Scala type system.

Partitioned into GroundType and TypeProxy.

Also partitioned into TermType, WildcardTypeBounds and CustomTransientGroundType.

Attributes

Supertypes: class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Known subtypes: trait BoundType

trait ParamRef

class TermParamRef

class TypeParamRef

class RecThis

class GroundType

class AndType

class CustomTransientGroundType

trait MethodicType

class MethodType

class PolyType

class OrType

class PackageRef

class TypeLambda

trait TermType

trait LambdaType

trait TermLambdaType

trait TypeLambdaType

trait ValueType

class AnnotatedType

class AppliedType

class ByNameType

class MatchType

class NamedType

class TermRef

class TypeRef

class RefinedOrRecType

class RecType

class RefinedType

class TermRefinement

class TypeRefinement

trait SingletonType

class ConstantType

class SkolemType

class SuperType

class ThisType

class TypeProxy

class WildcardTypeBounds
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class TypeBounds

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait ParamRefBinders

trait Binders

class Object

trait Matchable

class Any
Known subtypes: class MatchTypeCase

trait TypeLambdaType

class PolyType

class TypeLambda

Attributes

Supertypes: trait TypeMappable

class Object

trait Matchable

class Any
Known subtypes: class RealTypeBounds

class TypeAlias

A type parameter of a type constructor.

Type parameters of polymorphic class types are Symbols.ClassTypeParamSymbols. For other type constructors, they are instances of an unspecified subclass.

See Type.typeParams.

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class ClassTypeParamSymbol

Attributes

Companion: object
Supertypes: trait TypeLambdaType

trait TypeBinders

trait LambdaType

trait ParamRefBinders

trait Binders

trait ValueType

trait TermType

class GroundType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class TypeLambdaTypeCompanion[TypeLambda]

class LambdaTypeCompanion[TypeName, TypeBounds, TypeLambda]

class Object

trait Matchable

class Any
Self type: TypeLambda.type

Attributes

Supertypes: trait TypeBinders

trait LambdaType

trait TermType

trait ParamRefBinders

trait Binders

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class PolyType

class TypeLambda

Attributes

Supertypes: class LambdaTypeCompanion[TypeName, TypeBounds, LT]

class Object

trait Matchable

class Any
Known subtypes: object PolyType.type

object TypeLambda.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class Prefix

object NoPrefix.type

class Type

trait BoundType

trait ParamRef

class TermParamRef

class TypeParamRef

class RecThis

class GroundType

class AndType

class CustomTransientGroundType

trait MethodicType

class MethodType

class PolyType

class OrType

class PackageRef

class TypeLambda

trait TermType

trait LambdaType

trait TermLambdaType

trait TypeLambdaType

trait ValueType

class AnnotatedType

class AppliedType

class ByNameType

class MatchType

class NamedType

class TermRef

class TypeRef

class RefinedOrRecType

class RecType

class RefinedType

class TermRefinement

class TypeRefinement

trait SingletonType

class ConstantType

class SkolemType

class SuperType

class ThisType

class TypeProxy

class WildcardTypeBounds

class TypeBounds

class RealTypeBounds

class TypeAlias
Show all

Attributes

Supertypes: trait ParamRef

trait BoundType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Type proxies. Each implementation is expected to redefine the underlying method.

Attributes

Supertypes: class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class AnnotatedType

class AppliedType

class ByNameType

class ConstantType

class MatchType

class NamedType

class TermRef

class TypeRef

class RefinedOrRecType

class RecType

class RefinedType

class TermRefinement

class TypeRefinement

trait SingletonType

class RecThis

class SkolemType

class SuperType

class TermParamRef

class ThisType

class TypeParamRef

class WildcardTypeBounds
Show all

Attributes

Companion: object
Supertypes: class NamedType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: TypeRef.type

A type refinement parent { type refinedName <:> refinedBounds }.

Value parameters

parent: The type being refined
refinedBounds: The refined bounds for the given type member
refinedName: The name of the refined type member

Attributes

Supertypes: class RefinedType

class RefinedOrRecType

trait ValueType

trait TermType

class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

A marker trait for the type of values or type lambdas.

In other words, what the spec calls a regular type.

Most TermTypes are ValueType. The only exceptions are MethodicType and PackageRef.

Attributes

Supertypes: trait TermType

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all
Known subtypes: class AndType

class AnnotatedType

class AppliedType

class ByNameType

class MatchType

class NamedType

class TermRef

class TypeRef

class OrType

class RefinedOrRecType

class RecType

class RefinedType

class TermRefinement

class TypeRefinement

trait SingletonType

class ConstantType

class RecThis

class SkolemType

class SuperType

class TermParamRef

class ThisType

class TypeLambda

class TypeParamRef
Show all

Attributes

Companion: object
Supertypes: class TypeProxy

class Type

class Prefix

trait TypeMappable

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: class Object

trait Matchable

class Any
Self type: WildcardTypeBounds.type

In this article

Generated with