implicit final class PrintableHelper extends AnyVal
- Alphabetic
- By Inheritance
- PrintableHelper
- AnyVal
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PrintableHelper(sc: StringContext)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##: Int
- Definition Classes
- Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from PrintableHelper toany2stringadd[PrintableHelper] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (PrintableHelper, B)
- Implicit
- This member is added by an implicit conversion from PrintableHelper toArrowAssoc[PrintableHelper] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cf(args: Any*): Printable
Custom string interpolator for generating formatted Printables : cf"..."
Custom string interpolator for generating formatted Printables : cf"..."
Enhanced version of scala's
finterpolator. Each expression (argument) referenced within the string is converted to a particular Printable depending on the format specifier and type.For Chisel types referenced within the String
%n- Returns Name Printable.%N- Returns FullName Printable.%b,%d,%x,%c- Only applicable for types of Bits or derived from it. - returns (Binary,Decimal, Hexadecimal,Character) Printable respectively.- Default - If no specifier given call Data.toPrintable on the Chisel Type.
For Printable type:
No explicit format specifier supported - just return the Printable.
For regular scala types
Call String.format with the argument and specifier. Default is %s if no specifier is given. Wrap the result in PString Printable.
For the parts of the StringContext
Remove format specifiers and if literal percents (need to be escaped with %) are present convert them into Percent Printable. Rest of the string will be wrapped in PString Printable.
- Annotations
- @nowarn()
val w1 = 20.U // Chisel UInt type (which extends Bits) val f1 = 30.2 // Scala float type. val pable = cf"w1 = $w1%x f1 = $f1%2.2f. This is 100%% clear" // the val `pable` is equivalent to the following // Printables(List(PString(w1 = ), Hexadecimal(UInt<5>(20)), PString( f1 = ), PString(30.20), PString(. This is 100), Percent, PString( clear)))
throws UnknownFormatConversionException if literal percent not escaped with % or if the format specifier is not supported for the specific type throws StringContext.InvalidEscapeException if a
partsstring contains a backslash (\) character that does not start a valid escape sequence. throws IllegalArgumentException if the number ofpartsin the enclosingStringContextdoes not exceed the number of argumentsargby exactly 1.
Example: - def ensuring(cond: (PrintableHelper) => Boolean, msg: => Any): PrintableHelper
- Implicit
- This member is added by an implicit conversion from PrintableHelper toEnsuring[PrintableHelper] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (PrintableHelper) => Boolean): PrintableHelper
- Implicit
- This member is added by an implicit conversion from PrintableHelper toEnsuring[PrintableHelper] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): PrintableHelper
- Implicit
- This member is added by an implicit conversion from PrintableHelper toEnsuring[PrintableHelper] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): PrintableHelper
- Implicit
- This member is added by an implicit conversion from PrintableHelper toEnsuring[PrintableHelper] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def p(args: Any*): Printable
Custom string interpolator for generating Printables: p"..." mimicks s"..." for non-Printable data)
- val sc: StringContext
- def toString(): String
- Definition Classes
- Any
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from PrintableHelper toStringFormat[PrintableHelper] 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): (PrintableHelper, B)
- Implicit
- This member is added by an implicit conversion from PrintableHelper toArrowAssoc[PrintableHelper] 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,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.