Yadukrishnan
Scribblings of an introvert

Scribblings of an introvert

Tagged Types in Scala

Tagged Types in Scala

Yadukrishnan's photo
Yadukrishnan
·Apr 5, 2022·

3 min read

Subscribe to my newsletter and never miss my upcoming articles

What is Tagged Type?

Tagged Type is a concept used in programming languages to enrich the type and avoid some common mistakes. For example, assume that we have a method which takes 2 String parameters, userId and name:

def printInfo(userId: String, name: String) = {
    println(s"HEY, userId: $userId and name:$name")
}

While invoking the printInfo function, if we accidentally provide name in place of userId and vice versa, the compiler will not show any error as the syntax is correct.

So we can call the function as:

printInfo("user234", "Yadu Krishnan")
printlnfo("Yadu Krishnan", "user234")

To avoid such mistakes, tagged types come in handy. The main advantage is that the add-on type it is erased after compilation, so that only the underlying original type will exist in the runtime. This will reduce the runtime overhead, but provide safety at compile time.

How to Use Tagged Type in Scala?

Tagged types are not available in Scala standard library. Many libraries like Scalaz, Shapeless, Scala-Common, etc have their own implementation. Here, let's look at how we can use Shapeless implementation of Tagged Type.

Shapeless provides the method tag to mark a type with additional information. We create empty traits to tag a type first.

trait UserId
trait Name

Now let's modify printInfo() function to use tagged types instead of String:

def printInfo(userId: String @@ UserId, name: String @@ Name) = {
    println(s"HEY, userId: ${formatString(userId)} and name:${formatString(name)}")
}
def formatString(str: String) = s"`${str}`"

Here, userId parameter is having the type String@@UserId and name is of type String@@Name. The type on the left side of @@ is the original type. Now, let's see how we can invoke the function:

val userId = tag[UserId][String]("user234")
val name = tag[Name][String]("Yadu Krishnan")
printInfo(userId, name)

If we try to call the method with wrong parameter, it will show compilation error:

printInfo(name, userId) // compilation error
printInfo("hey","heyhey") // compilation error

We can directly use this tagged type where the underlying type is needed. For example, the method formatString() in the previous code sample takes a parameter String. Without any transformation, we can directly call formatString(userId). Full code sample is available in Github as a gist.

Drawbacks

Since tagged type is not available in the standard library, each libraries implements its own version. So there is no standard or interchangeable version for this approach.

Alternatives

There are some alternatives in Scala for Type Tagging. But each one has its own advantages and disadvantages. Depending on the situation, we can select the best way to handle such scenario(including the usage of @@ if you are already using a supporting library)

Some of the alternatives that can be checked are:

 
Share this