Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package testing
    Definition Classes
    chisel3
  • package scalatest
    Definition Classes
    testing
  • FileCheck
  • HasTestingDirectory

trait HasTestingDirectory extends AnyRef

This is a trait that can be mixed into a class to determine where compilation should happen and where simulation artifacts should be written.

Self Type
HasTestingDirectory
Source
HasTestingDirectory.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasTestingDirectory
  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 getDirectory: Path

    Return the directory where tests should be placed.

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 HasTestingDirectory toany2stringadd[HasTestingDirectory] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HasTestingDirectory, B)
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toArrowAssoc[HasTestingDirectory] 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: (HasTestingDirectory) => Boolean, msg: => Any): HasTestingDirectory
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toEnsuring[HasTestingDirectory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (HasTestingDirectory) => Boolean): HasTestingDirectory
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toEnsuring[HasTestingDirectory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): HasTestingDirectory
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toEnsuring[HasTestingDirectory] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): HasTestingDirectory
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toEnsuring[HasTestingDirectory] 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()
  26. def withSubdirectory(subdirectory: String): HasTestingDirectory

    Factory that returns a new HasTestingDirectory which will put test files in a subdirectory of the parent HasTestingDirectory.

    Factory that returns a new HasTestingDirectory which will put test files in a subdirectory of the parent HasTestingDirectory.

    For example, the object bar will have an output directory of foo/bar/.

    import java.nio.file.Paths

val foo = new HasTestingDirectory {
  override def getDirectory = Paths.get("foo")
}

val bar = foo.getSubDir("bar")
    subdirectory

    a subdirectory

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toStringFormat[HasTestingDirectory] 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): (HasTestingDirectory, B)
    Implicit
    This member is added by an implicit conversion from HasTestingDirectory toArrowAssoc[HasTestingDirectory] 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 fromHasTestingDirectory to any2stringadd[HasTestingDirectory]

Inherited by implicit conversion StringFormat fromHasTestingDirectory to StringFormat[HasTestingDirectory]

Inherited by implicit conversion Ensuring fromHasTestingDirectory to Ensuring[HasTestingDirectory]

Inherited by implicit conversion ArrowAssoc fromHasTestingDirectory to ArrowAssoc[HasTestingDirectory]

Ungrouped