Trait

scala.reflect.api

TypeTags

Related Doc: package api

Permalink

trait TypeTags extends AnyRef

A TypeTag[T] encapsulates the runtime type representation of some type T. Like scala.reflect.Manifest, the prime use case of TypeTags is to give access to erased types. However, TypeTags should be considered to be a richer replacement of the pre-2.10 notion of a Manifest, that are, in addition, fully integrated with Scala reflection.

There exist three different types of TypeTags:

Like Manifests, TypeTags are always generated by the compiler, and can be obtained in three ways:

#1 Via the methods typeTag, classTag, or weakTypeTag

For example:

import scala.reflect.runtime.universe._
val tt = typeTag[Int]

import scala.reflect._
val ct = classTag[String]

Each of these methods constructs a TypeTag[T] or ClassTag[T] for the given type argument T.

#2 Using an implicit parameter of type TypeTag[T], ClassTag[T], or WeakTypeTag[T]

For example:

import scala.reflect.runtime.universe._

def paramInfo[T](x: T)(implicit tag: TypeTag[T]): Unit = {
  val targs = tag.tpe match { case TypeRef(_, _, args) => args }
  println(s"type of $x has type arguments $targs")
}

scala> paramInfo(42)
type of 42 has type arguments List()

scala> paramInfo(List(1, 2))
type of List(1, 2) has type arguments List(Int)
#3 Context bound of a type parameter

...on methods or classes. The above example can be implemented as follows:

import scala.reflect.runtime.universe._

def paramInfo[T: TypeTag](x: T): Unit = {
  val targs = typeOf[T] match { case TypeRef(_, _, args) => args }
  println(s"type of $x has type arguments $targs")
}

scala> paramInfo(42)
type of 42 has type arguments List()

scala> paramInfo(List(1, 2))
type of List(1, 2) has type arguments List(Int)
WeakTypeTags

WeakTypeTag[T] generalizes TypeTag[T]. Unlike a regular TypeTag, components of its type representation can be references to type parameters or abstract types. However, WeakTypeTag[T] tries to be as concrete as possible, i.e. if type tags are available for the referenced type arguments or abstract types, they are used to embed the concrete types into the WeakTypeTag[T].

Continuing the example above:

def weakParamInfo[T](x: T)(implicit tag: WeakTypeTag[T]): Unit = {
  val targs = tag.tpe match { case TypeRef(_, _, args) => args }
  println(s"type of $x has type arguments $targs")
}

scala> def foo[T] = weakParamInfo(List[T]())
foo: [T]=> Unit

scala> foo[Int]
type of List() has type arguments List(T)
TypeTags and Manifests

TypeTags correspond loosely to the pre-2.10 notion of scala.reflect.Manifests. While scala.reflect.ClassTag corresponds to scala.reflect.ClassManifest and scala.reflect.api.TypeTags#TypeTag mostly corresponds to scala.reflect.Manifest, other pre-2.10 Manifest types do not have a direct correspondence with a 2.10 "Tag" type.

In Scala 2.10, scala.reflect.ClassManifests are deprecated, and it is planned to deprecate scala.reflect.Manifest in favor of TypeTags and ClassTags in an upcoming point release. Thus, it is advisable to migrate any Manifest-based APIs to use Tags.

For more information about TypeTags, see the Reflection Guide: TypeTags

Self Type
Universe
Source
TypeTags.scala
See also

scala.reflect.ClassTag, scala.reflect.api.TypeTags#TypeTag, scala.reflect.api.TypeTags#WeakTypeTag

Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. TypeTags
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

TypeTags

  1. trait TypeTag[T] extends Universe.WeakTypeTag[T] with Equals with Serializable

    Permalink

    A TypeTag is a scala.reflect.api.TypeTags#WeakTypeTag with the additional static guarantee that all type references are concrete, i.e.

    A TypeTag is a scala.reflect.api.TypeTags#WeakTypeTag with the additional static guarantee that all type references are concrete, i.e. it does not contain any references to unresolved type parameters or abstract types.

    Annotations
    @implicitNotFound( "No TypeTag available for ${T}" )
    See also

    scala.reflect.api.TypeTags

  2. trait WeakTypeTag[T] extends Equals with Serializable

    Permalink

    If an implicit value of type WeakTypeTag[T] is required, the compiler will create one, and the reflective representation of T can be accessed via the tpe field.

    If an implicit value of type WeakTypeTag[T] is required, the compiler will create one, and the reflective representation of T can be accessed via the tpe field. Components of T can be references to type parameters or abstract types. Note that WeakTypeTag makes an effort to be as concrete as possible, i.e. if TypeTags are available for the referenced type arguments or abstract types, they are used to embed the concrete types into the WeakTypeTag. Otherwise the WeakTypeTag will contain a reference to an abstract type. This behavior can be useful, when one expects T to be perhaps be partially abstract, but requires special care to handle this case. However, if T is expected to be fully known, use scala.reflect.api.TypeTags#TypeTag instead, which statically guarantees this property.

    For more information about TypeTags, see the Reflection Guide: TypeTags

    Annotations
    @implicitNotFound( "No WeakTypeTag available for ${T}" )
    See also

    scala.reflect.api.TypeTags

  1. abstract def symbolOf[T](implicit arg0: Universe.WeakTypeTag[T]): Universe.TypeSymbol

    Permalink

    Type symbol of x as derived from a type tag.

  2. object TypeTag extends Serializable

    Permalink

    Type tags corresponding to primitive types and constructor/extractor for WeakTypeTags.

  3. object WeakTypeTag extends Serializable

    Permalink

    Type tags corresponding to primitive types and constructor/extractor for WeakTypeTags.

  4. def typeOf[T](implicit ttag: Universe.TypeTag[T]): Universe.Type

    Permalink

    Shortcut for implicitly[TypeTag[T]].tpe

  5. def typeTag[T](implicit ttag: Universe.TypeTag[T]): Universe.TypeTag[T]

    Permalink

    Shortcut for implicitly[TypeTag[T]]

  6. def weakTypeOf[T](implicit attag: Universe.WeakTypeTag[T]): Universe.Type

    Permalink

    Shortcut for implicitly[WeakTypeTag[T]].tpe

  7. def weakTypeTag[T](implicit attag: Universe.WeakTypeTag[T]): Universe.WeakTypeTag[T]

    Permalink

    Shortcut for implicitly[WeakTypeTag[T]]