Migrating from Iron 2.x to 3.x

Some major API changes have been introduced in Iron 3.0.0 compared to Iron 2.x. Most of them involved minor changes from a Iron 2.x codebase to 3.x.

Custom Constraint instances

The parameter value of method test in Constraint is now inline. If you made a custom Constraint instance such, for example:

given Constraint[Foo, Bar] with
  inline def test(value: Foo): Boolean = ???
  inline def message: String = ???

You need to make value inline:

given Constraint[Foo, Bar] with
  inline def test(inline value: Foo): Boolean = ???
  inline def message: String = ???

Refined type definition

Many changes related to RefinedTypeOps definition have been introduced to provide better ergonomy.

In 2.x:

opaque type Temperature = Double :| Positive
object Temperature extends RefinedTypeOps[Double, Positive, Temperature]

In 3.x:

type Temperature = Temperature.T
object Temperature extends RefinedType[Double, Positive]

• RefinedTypeOps is now RefinedType
• All newtypes are opaque, you can no longer make transparent types

You also no longer need to duplicate the constraint type, therefore, the following pattern is obsolete:

type TemperatureR = DescribedAs[Positive, "Temperature should be positive"]
opaque type Temperature = Double :| TemperatureR
object Temperature extends RefinedTypeOps[Double, TemperatureR, Temperature]