izumi.fundamentals.platform.language.Quirks.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fundamentals-language_2.13 Show documentation

fundamentals-language

The newest version!

package izumi.fundamentals.platform.language

import scala.annotation.unused
import scala.language.implicitConversions

/**
  * Syntax for explicitly discarding values to satisfy `-Ywarn-value-discard` and for clarity of course!
  *
  * @see also [[scala.annotation.unused]]
  */
object Quirks {

  @inline implicit final class Discarder[T](private val t: T) extends AnyVal {
    @inline def discard(): Unit = ()
  }

  @inline final def discard(@unused trash1: Any): Unit = ()
  @inline final def discard(@unused trash1: Any, @unused trash2: Any): Unit = ()
  @inline final def discard(@unused trash1: Any, @unused trash2: Any, @unused trash3: Any): Unit = ()
  @inline final def discard(@unused trash1: Any, @unused trash2: Any, @unused trash3: Any, @unused trash4: Any): Unit = ()
  @inline final def discard(@unused trash1: Any, @unused trash2: Any, @unused trash3: Any, @unused trash4: Any, @unused trash: Any*): Unit = ()

  @inline final class LazyDiscarder[U >: Unit](private val dummy: Boolean = false) extends AnyVal {
    @inline def forget: U = ()
  }
  @inline implicit final def LazyDiscarder[T](@unused t: => T): LazyDiscarder[Unit] = new LazyDiscarder[Unit]()

  @inline final def forget(@unused trash: LazyDiscarder[?]*): Unit = ()

}