super traits
Traits are used in two roles:
- As mixins for other classes and traits
- As types of vals, defs, or parameters
Some traits are used primarily in the first role, and we usually do not want to see them in inferred types. An example is the Product
trait that the compiler
adds as a super trait to every case class or case object. In Scala 2, this parent trait sometimes makes inferred types more complicated than they should be. Example:
trait Kind
case object Var extends Kind
case object Val extends Kind
val x = Set(if condition then Val else Var)
Here, the inferred type of x
is Set[Kind & Product & Serializable]
whereas one would have hoped it to be Set[Kind]
. The reasoning for this particular type to be inferred is as follows:
- The type of the conditional above is the union type
Val | Var
. - A union type is widened in type inference to the least supertype that is
not a union type. In the example, this type is
Kind & Product & Serializable
since all three traits are supertraits of bothVal
andVar
. So that type becomes the inferred element type of the set.
Scala 3 allows one to mark a trait as a super
trait, which means that it can be suppressed in type inference. Here's an example that follows the lines of the
code above, but now with a new super trait S
instead of Product
:
super trait S
trait Kind
object Var extends Kind, S
object Val extends Kind, S
val x = Set(if condition then Val else Var)
Now x
has inferred type Set[Kind]
. The common super trait S
does not
appear in the inferred type.
Super Traits
The traits scala.Product
, java.lang.Serializable
and java.lang.Comparable
are treated automatically as super traits. Other traits can be turned into super traits, by adding the keyword super
in front of trait
, as shown above.
Every trait can be declared as a super trait. Typically super traits are traits that influence the implementation of inheriting classes and traits and that are not usually used as types by themselves. Two examples from the standard collection library:
IterableOps
, which provides method implementations for anIterable
StrictOptimizedSeqOps
, which optimises some of these implementations for sequences with efficient indexing.
Generally, any trait that is extended recursively is a good candidate to be declared a super trait.
Retro-Fitting Scala 2 Libraries
To allow cross-building between Scala 2 and 3, super traits can also be
introduced by adding the @superTrait
annotation, which is defined in package scala.annotation
. Example:
import scala.annotation.superTrait
@superTrait trait StrictOptimizedSeqOps[+A, +CC[_], +C] ...
The @superTrait
annotation will be deprecated and removed in some later version of Scala when cross-building with Scala 2 will no longer be a concern.
Rules for Inference
Super traits can be given as explicit types as usual. But they are often elided when types are inferred. Roughly, the rules for type inference say that super traits are dropped from intersections where possible.
The precise rules are as follows:
- When inferring a type of a type variable, or the type of a val, or the return type of a def,
- where that type is not higher-kinded,
- and where
B
is its known upper bound orAny
if none exists: - If the type inferred so far is of the form
T1 & ... & Tn
wheren >= 1
, replace the maximal number ofTi
s byAny
, while ensuring that the resulting type is still a subtype of the boundB
. - However, do not perform this widening if all types
Ti
can get replaced in that way.
The last clause ensures that a single super trait instance such as Product
is not widened to Any
. Super trait instances are only dropped when they appear in conjunction with some other type.
Syntax
Only the production TmplDef
for class and trait definitions has to be changed.
The new version is:
TmplDef ::= ([‘case’] ‘class’ | [‘super’] ‘trait’) ClassDef