Packages

trait InlineInstance extends AnyRef

Inlines an instance of a module

Self Type
InlineInstance with BaseModule
Source
Inline.scala
Example:
  1. trait Internals { this: Module =>
      val io = IO(new Bundle{ val a = Input(Bool()) })
    }
    class Sub extends Module with Internals
    trait HasSub { this: Module with Internals =>
      val sub = Module(new Sub)
      sub.io.a := io.a
    }
    /* InlineInstance is mixed directly into Foo's definition. Every instance
     * of this will be inlined. */
    class Foo extends Module with Internals with InlineInstance with HasSub
    /* Bar will, by default, not be inlined */
    class Bar extends Module with Internals with HasSub
    /* The resulting instances will be:
     - Top
     - Top.x$sub
     - Top.y$sub
     - Top.z
     - Top.z.sub */
    class Top extends Module with Internals {
      val x = Module(new Foo)                     // x will be inlined
      val y = Module(new Bar with InlineInstance) // y will also be inlined
      val z = Module(new Bar)                     // z will not be inlined
      Seq(x, y, z).map(_.io.a := io.a)
    }
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InlineInstance
  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 InlineInstance toany2stringadd[InlineInstance] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InlineInstance, B)
    Implicit
    This member is added by an implicit conversion from InlineInstance toArrowAssoc[InlineInstance] 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: (InlineInstance) => Boolean, msg: => Any): InlineInstance
    Implicit
    This member is added by an implicit conversion from InlineInstance toEnsuring[InlineInstance] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (InlineInstance) => Boolean): InlineInstance
    Implicit
    This member is added by an implicit conversion from InlineInstance toEnsuring[InlineInstance] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): InlineInstance
    Implicit
    This member is added by an implicit conversion from InlineInstance toEnsuring[InlineInstance] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): InlineInstance
    Implicit
    This member is added by an implicit conversion from InlineInstance toEnsuring[InlineInstance] 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 InlineInstance toStringFormat[InlineInstance] 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): (InlineInstance, B)
    Implicit
    This member is added by an implicit conversion from InlineInstance toArrowAssoc[InlineInstance] 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 fromInlineInstance to any2stringadd[InlineInstance]

Inherited by implicit conversion StringFormat fromInlineInstance to StringFormat[InlineInstance]

Inherited by implicit conversion Ensuring fromInlineInstance to Ensuring[InlineInstance]

Inherited by implicit conversion ArrowAssoc fromInlineInstance to ArrowAssoc[InlineInstance]

Ungrouped