Trait

shapeless.compat

Ignoring

Related Doc: package compat

Permalink

trait Ignoring[M, T] extends AnyRef

Allows to ignore some implicits in a LowPriority[T].

Use like LowPriority[Ignoring[Witness."ignoredMethod".T, T]].

Typical usage is when a fallback for type class TC is defined in its companion, like

object TC {
  implicit def anyTC[T]: TC[T] = ...
}

With the example of LowPriority[T] above,

trait TC[T] {
  def prop: Option[Boolean]
}

trait LowPriTC {
  // default low priority TC[T] for any T, with field `prop` equal to `None`
  implicit def anyTC[T]: TC[T] = new TC[T] { def prop = None }
}

object TC extends LowPriTC {
  // TC[Int] available by default, with field `prop` equal to `Some(true)`
  implicit val intTC: TC[Int] = new TC[Int] { def prop = Some(true) }
}

// extra `TC[T]`, with field `prop` equal to `Some(false)`
implicit def extraTC[T](implicit ev: LowPriority[Ignoring[Witness.`"anyTC"`.T, TC[T]]]): TC[T] =
  new TC[T] { def prop = Some(false) }

// Already available instance `intTC` is still found, because `extraTC[Int]` requires a
// `LowPriority[TC[Int]]`, that will refuse to materialize (because `LowPriority` is able to
// know about the already available `intTC`.)
assert(implicitly[TC[Int]].prop == true)

// `extraTC[String]` is found, as the default `anyTC[String]` is ignored,
assert(implicitly[TC[String]].prop == false)
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Ignoring
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped