scodec.Iso.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scodec-core_sjs1_3 Show documentation
scodec-core
There is a newer version: 2.3.2
/*
 * Copyright (c) 2013, Scodec
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package scodec

import scala.deriving.Mirror

@annotation.implicitNotFound("""Could not prove ${A} is isomorphic to ${B}.""")
trait Iso[A, B]:
  self =>
  def to(a: A): B
  def from(b: B): A

  final def inverse: Iso[B, A] = new Iso[B, A]:
    def to(b: B) = self.from(b)
    def from(a: A) = self.to(a)

private trait IsoLowPriority:
  def instance[A, B](t: A => B)(f: B => A): Iso[A, B] =
    new Iso[A, B]:
      def to(a: A) = t(a)
      def from(b: B) = f(b)

  given inverse[A, B](using iso: Iso[A, B]): Iso[B, A] = iso.inverse

  inline given productWithUnits[A <: Tuple, B <: Product](using
      m: Mirror.ProductOf[B] { type MirroredElemTypes = DropUnits[A] }
  ): Iso[A, B] =
    instance((a: A) => fromTuple(DropUnits.drop(a)))(b => DropUnits.insert(toTuple(b)))

  // For bincompat with 2.0.0
  private[scodec] inline def productWithUnits[A <: Tuple, B <: Product](using
      m: Mirror.ProductOf[B],
      ev: m.MirroredElemTypes =:= DropUnits[A]
  ): Iso[A, B] =
    productWithUnits(using m.asInstanceOf)

  protected def toTuple[A <: Product](a: A)(using m: Mirror.ProductOf[A]): m.MirroredElemTypes =
    Tuple.fromProductTyped(a)

  protected def fromTuple[A](using m: Mirror.ProductOf[A])(t: m.MirroredElemTypes): A =
    m.fromProduct(t)

/** Companion for [[Iso]]. */
object Iso extends IsoLowPriority:

  /** Identity iso. */
  given id[A]: Iso[A, A] = instance[A, A](identity)(identity)

  given product[A <: Tuple, B <: Product](using
      m: Mirror.ProductOf[B] { type MirroredElemTypes = A }
  ): Iso[A, B] =
    instance[A, B](fromTuple)(toTuple)

  // For bincompat with 2.0.0
  private[scodec] def product[A <: Tuple, B <: Product](using
      m: Mirror.ProductOf[B],
      ev: m.MirroredElemTypes =:= A
  ): Iso[A, B] =
    product(using m.asInstanceOf)

  given singleton[A, B <: Product](using
      m: Mirror.ProductOf[B] { type MirroredElemTypes = A *: EmptyTuple }
  ): Iso[A, B] =
    instance[A, B](a => fromTuple(a *: EmptyTuple))(b => toTuple(b).head)

  // For bincompat with 2.0.0
  private[scodec] def singleton[A, B <: Product](using
      m: Mirror.ProductOf[B],
      ev: m.MirroredElemTypes =:= (A *: EmptyTuple)
  ): Iso[A, B] =
    singleton(using m.asInstanceOf)