chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  object Data
  Definition Classes
    chisel3
- ConnectableDefault
- ConnectableVecDefault
- DataEquality

c

chisel3.Data

# DataEquality

###

#### implicit class DataEquality[T <: Data] extends AnyRef

Provides generic, recursive equality for Bundle and Vec hardware. This avoids the need to use workarounds such as `bundle1.asUInt === bundle2.asUInt` by allowing users to instead write `bundle1 === bundle2`.

Static type safety of this comparison is guaranteed at compile time as the extension method requires the same parameterized type for both the left-hand and right-hand sides. It is, however, possible to get around this type safety using `Bundle` subtypes that can differ during runtime (e.g. through a generator). These cases are subsequently raised as elaboration errors.

Source
  Data.scala

Linear Supertypes
AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. DataEquality
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

### Instance Constructors

1.  new DataEquality(lhs: T)(implicit sourceInfo: SourceInfo)

   lhs

     The Data hardware on the left-hand side of the equality

### 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 DataEquality[T] toany2stringadd[DataEquality[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (DataEquality[T], B)
   Implicit
     This member is added by an implicit conversion from DataEquality[T] toArrowAssoc[DataEquality[T]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def ===(rhs: T): Bool

   Dynamic recursive equality operator for generic Data

   Dynamic recursive equality operator for generic Data

   rhs

     a hardware Data to compare `lhs` to

   returns

     a hardware Bool asserted if `lhs` is equal to `rhs`

   Exceptions thrown

     `ChiselException` when `lhs` and `rhs` are different types during elaboration time

7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
9.  def ensuring(cond: (DataEquality[T]) => Boolean, msg: => Any): DataEquality[T]
   Implicit
     This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (DataEquality[T]) => Boolean): DataEquality[T]
    Implicit
      This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): DataEquality[T]
    Implicit
      This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): DataEquality[T]
    Implicit
      This member is added by an implicit conversion from DataEquality[T] toEnsuring[DataEquality[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
15.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
16.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
19.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
20.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
23.  def toString(): String
    Definition Classes
      AnyRef → Any
24.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
26.  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 DataEquality[T] toStringFormat[DataEquality[T]] 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): (DataEquality[T], B)
   Implicit
     This member is added by an implicit conversion from DataEquality[T] toArrowAssoc[DataEquality[T]] 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 fromDataEquality[T] to any2stringadd[DataEquality[T]]

### Inherited by implicit conversion StringFormat fromDataEquality[T] to StringFormat[DataEquality[T]]

### Inherited by implicit conversion Ensuring fromDataEquality[T] to Ensuring[DataEquality[T]]

### Inherited by implicit conversion ArrowAssoc fromDataEquality[T] to ArrowAssoc[DataEquality[T]]

### Ungrouped