case class CircuitSerializationAnnotation(circuit: Circuit, filename: String, format: Format) extends NoTargetAnnotation with BufferedCustomFileEmission with Product with Serializable
Wraps a Circuit for serialization via CustomFileEmission
- circuit
a Chisel Circuit
- filename
name of destination file (excludes file extension)
- format
serialization file format (sets file extension)
- Source
- ChiselAnnotations.scala
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- CircuitSerializationAnnotation
- Serializable
- BufferedCustomFileEmission
- CustomFileEmission
- NoTargetAnnotation
- Annotation
- Product
- Equals
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
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 CircuitSerializationAnnotation toany2stringadd[CircuitSerializationAnnotation] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (CircuitSerializationAnnotation, B)
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toArrowAssoc[CircuitSerializationAnnotation] 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 baseFileName(annotations: AnnotationSeq): String
- Attributes
- protected
- Definition Classes
- CircuitSerializationAnnotation → CustomFileEmission
- val circuit: Circuit
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (CircuitSerializationAnnotation) => Boolean, msg: => Any): CircuitSerializationAnnotation
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toEnsuring[CircuitSerializationAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (CircuitSerializationAnnotation) => Boolean): CircuitSerializationAnnotation
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toEnsuring[CircuitSerializationAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): CircuitSerializationAnnotation
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toEnsuring[CircuitSerializationAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): CircuitSerializationAnnotation
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toEnsuring[CircuitSerializationAnnotation] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def filename(annotations: AnnotationSeq): File
- Definition Classes
- CustomFileEmission
- val filename: String
- val format: Format
- final def getBytes: Iterable[Byte]
- Definition Classes
- BufferedCustomFileEmission → CustomFileEmission
- def getBytesBuffered: Iterable[Array[Byte]]
- Definition Classes
- CircuitSerializationAnnotation → BufferedCustomFileEmission
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getTargets: Seq[Target]
- Definition Classes
- NoTargetAnnotation → Annotation
- lazy val hashCode: Int
- Definition Classes
- CircuitSerializationAnnotation → AnyRef → Any
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def replacements(file: File): AnnotationSeq
- Definition Classes
- CustomFileEmission
- def serialize: String
- Definition Classes
- Annotation
- def suffix: Option[String]
- Attributes
- protected
- Definition Classes
- CircuitSerializationAnnotation → CustomFileEmission
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def update(renames: RenameMap): Seq[NoTargetAnnotation]
- Definition Classes
- NoTargetAnnotation → Annotation
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toStringFormat[CircuitSerializationAnnotation] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (CircuitSerializationAnnotation, B)
- Implicit
- This member is added by an implicit conversion from CircuitSerializationAnnotation toArrowAssoc[CircuitSerializationAnnotation] 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.
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,FixedPoint,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.