Packages

trait HasTypeAlias extends AnyRef

Self Type
HasTypeAlias with Record
Source
HasTypeAlias.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasTypeAlias
  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

Abstract Value Members

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

    Examples:
    1. 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.

    2. ,
    3. 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.

Concrete 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 HasTypeAlias toany2stringadd[HasTypeAlias] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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()
  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: (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
  9. 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
  10. 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
  11. 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
  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 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 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): (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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHasTypeAlias to any2stringadd[HasTypeAlias]

Inherited by implicit conversion StringFormat fromHasTypeAlias to StringFormat[HasTypeAlias]

Inherited by implicit conversion Ensuring fromHasTypeAlias to Ensuring[HasTypeAlias]

Inherited by implicit conversion ArrowAssoc fromHasTypeAlias to ArrowAssoc[HasTypeAlias]

Ungrouped