io.github.iltotore.iron.upickle.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iron-upickle_sjs1_3 Show documentation

Strong type constraints for Scala

The newest version!

package io.github.iltotore.iron

import _root_.upickle.core.Abort
import _root_.upickle.default.*
import io.github.iltotore.iron.{:|, Constraint, RefinedTypeOps, refineEither}

/**
 * Implicit `Reader`s and `Writer`s for refined types using uPickle.
 */
object upickle:

  /**
   * A `Reader` for refined types using uPickle. Decodes to the underlying type then checks the constraint.
   *
   * @param reader the `Reader` of the underlying type.
   * @param constraint the `Constraint` implementation to test the decoded value.
   */
  inline given [A, B](using inline reader: Reader[A], inline constraint: Constraint[A, B]): Reader[A :| B] =
    reader.map(value =>
      value.refineEither match
        case Right(refinedValue) => refinedValue
        case Left(errorMessage)  => throw Abort(errorMessage)
    )

  /**
   * A `Writer` instance for refined types using uPickle. This is essentially the underlying type `Writer`.
   *
   * @param writer the `Writer` of the underlying type.
   */
  inline given [A, B](using inline writer: Writer[A]): Writer[A :| B] = writer.asInstanceOf[Writer[A :| B]]

  /**
   * A uPickle `Reader` based on refined type mirrors.
   *
   * @param mirror the type mirror for refined types.
   * @param ev the underlying `Reader` for the iron type.
   */
  inline given [T](using mirror: RefinedTypeOps.Mirror[T], ev: Reader[mirror.IronType]): Reader[T] =
    ev.asInstanceOf[Reader[T]]

  /**
   * A uPickle `Writer` based on refined type mirrors.
   *
   * @param mirror the type mirror for refined types.
   * @param ev the underlying `Writer` for the iron type.
   */
  inline given [T](using mirror: RefinedTypeOps.Mirror[T], ev: Writer[mirror.IronType]): Writer[T] =
    ev.asInstanceOf[Writer[T]]