trait HasTypeAlias extends AnyRef
- Alphabetic
- By Inheritance
- HasTypeAlias
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def aliasName: RecordAlias
An optional FIRRTL type alias name to give to this Record.
An optional FIRRTL type alias name to give to this Record. If overrided with an instance of a RecordAlias, such as
RecordAlias("UserBundle")
, this causes emission of circuit-level FIRRTL statements that declare that name for this bundle type:class MyBundle extends Bundle with HasTypeAlias { override def aliasName = RecordAlias("UserBundle") }
circuit Top : type UserBundle = { ... } module Top : // ...
This is used as a strong hint for the generated type alias: steps like sanitization and disambiguation may change the resulting alias by necessity, so there is no certain guarantee that the desired name will show up in the generated FIRRTL. In case of coercion with Input and Output, which inherently modifies the structure of Records, an additional suffix is appended to any such Records which contain flipped values subsequently 'stripped' by
Input
/Output
. , class MyBundle extends Bundle with HasTypeAlias { override def aliasName = RecordAlias("UserBundle") val foo = Flipped(UInt(8.W)) } class Top extends Module { val in = IO(Input(new MyBundle)) // Note that this strips flipped-ness from in.foo }
circuit Top : type UserBundle_stripped = { foo : UInt<8>} module Top : flip in : UserBundle_stripped // ...
This suffix can be modified by providing a secondary string when instantiating
RecordAlias
.
Examples:
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toany2stringadd[HasTypeAlias] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (HasTypeAlias, B)
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toArrowAssoc[HasTypeAlias] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (HasTypeAlias) => Boolean, msg: => Any): HasTypeAlias
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toEnsuring[HasTypeAlias] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (HasTypeAlias) => Boolean): HasTypeAlias
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toEnsuring[HasTypeAlias] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): HasTypeAlias
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toEnsuring[HasTypeAlias] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): HasTypeAlias
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toEnsuring[HasTypeAlias] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toStringFormat[HasTypeAlias] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (HasTypeAlias, B)
- Implicit
- This member is added by an implicit conversion from HasTypeAlias toArrowAssoc[HasTypeAlias] 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.