case class EmittedRtlilModuleAnnotation(name: String, value: String, outputSuffix: String) extends NoTargetAnnotation with CustomFileEmission with Product with Serializable
- Alphabetic
- By Inheritance
- EmittedRtlilModuleAnnotation
- Serializable
- Serializable
- CustomFileEmission
- NoTargetAnnotation
- Annotation
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new EmittedRtlilModuleAnnotation(name: String, value: String, outputSuffix: String)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
baseFileName(annotations: AnnotationSeq): String
Output filename where serialized content will be written
Output filename where serialized content will be written
The full annotation sequence is a parameter to allow for the location where this annotation will be serialized to be a function of other annotations, e.g., if the location where information is written is controlled by a separate file location annotation.
- annotations
the annotation sequence at the time of emission
- Attributes
- protected
- Definition Classes
- EmittedRtlilModuleAnnotation → CustomFileEmission
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
filename(annotations: AnnotationSeq): File
Method that returns the filename where this annotation will be serialized.
Method that returns the filename where this annotation will be serialized.
- annotations
the annotations at the time of serialization
- Definition Classes
- CustomFileEmission
-
def
getBytes: Iterable[Byte]
A method that can convert this annotation to bytes that will be written to a file.
A method that can convert this annotation to bytes that will be written to a file.
If you only need to serialize a string, you can use the
getBytesmethod:def getBytes: Iterable[Byte] = myString.getBytes
- Definition Classes
- EmittedRtlilModuleAnnotation → CustomFileEmission
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getTargets: Seq[Target]
Returns all Target members in this annotation
Returns all Target members in this annotation
- Definition Classes
- NoTargetAnnotation → Annotation
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
-
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()
- val outputSuffix: String
-
def
replacements(file: File): AnnotationSeq
Optionally, a sequence of annotations that will replace this annotation in the output annotation file.
Optionally, a sequence of annotations that will replace this annotation in the output annotation file.
A non-empty implementation of this method is a mechanism for telling a downstream Stage how to deserialize the information that was serialized to a separate file. For example, if a FIRRTL circuit is serialized to a separate file, this method could include an input file annotation that a later stage can use to read the serialized FIRRTL circuit back in.
- Definition Classes
- CustomFileEmission
-
def
serialize: String
Optional pretty print
Optional pretty print
- Definition Classes
- Annotation
- Note
rarely used
-
def
suffix: Option[String]
Optional suffix of the output file
Optional suffix of the output file
- Attributes
- protected
- Definition Classes
- EmittedRtlilModuleAnnotation → CustomFileEmission
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
update(renames: RenameMap): Seq[NoTargetAnnotation]
Update the target based on how signals are renamed
Update the target based on how signals are renamed
- Definition Classes
- NoTargetAnnotation → Annotation
- val value: String
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
This is the documentation for Firrtl.