Packages

sealed trait ChiselSubtypeOf[A, B] extends AnyRef

Enforces that A is a Chisel subtype of B.

A is a Chisel subtype of B if A contains all of B's fields (same names and same types). Only public fields that are subtypes of chisel3.Data are considered when checking for containment.

In the following example A is a Chisel subtype of B:

class A extends Bundle {
  val x = UInt(3.W)
  val y = UInt(3.W)
  val z = UInt(3.W)
}
class B extends Bundle {
  val x = UInt(3.W)
  val y = UInt(3.W)
}
Source
ChiselSubtypeOf.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChiselSubtypeOf
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toany2stringadd[ChiselSubtypeOf[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ChiselSubtypeOf[A, B], B)
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toArrowAssoc[ChiselSubtypeOf[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (ChiselSubtypeOf[A, B]) => Boolean, msg: => Any): ChiselSubtypeOf[A, B]
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toEnsuring[ChiselSubtypeOf[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ChiselSubtypeOf[A, B]) => Boolean): ChiselSubtypeOf[A, B]
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toEnsuring[ChiselSubtypeOf[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ChiselSubtypeOf[A, B]
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toEnsuring[ChiselSubtypeOf[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ChiselSubtypeOf[A, B]
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toEnsuring[ChiselSubtypeOf[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toStringFormat[ChiselSubtypeOf[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (ChiselSubtypeOf[A, B], B)
    Implicit
    This member is added by an implicit conversion from ChiselSubtypeOf[A, B] toArrowAssoc[ChiselSubtypeOf[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromChiselSubtypeOf[A, B] to any2stringadd[ChiselSubtypeOf[A, B]]

Inherited by implicit conversion StringFormat fromChiselSubtypeOf[A, B] to StringFormat[ChiselSubtypeOf[A, B]]

Inherited by implicit conversion Ensuring fromChiselSubtypeOf[A, B] to Ensuring[ChiselSubtypeOf[A, B]]

Inherited by implicit conversion ArrowAssoc fromChiselSubtypeOf[A, B] to ArrowAssoc[ChiselSubtypeOf[A, B]]

Ungrouped