chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package chisel3

  This package contains the main chisel3 API.

  This package contains the main chisel3 API.

  Definition Classes
    root
-  package aop
  Definition Classes
    chisel3
-  package choice

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  This package contains Chisel language definitions for describing configuration options and their accepted values.

  Definition Classes
    chisel3
-  package connectable
  Definition Classes
    chisel3
-  package experimental

  Package for experimental features, which may have their API changed, be removed, etc.

  Package for experimental features, which may have their API changed, be removed, etc.

  Because its contents won't necessarily have the same level of stability and support as non-experimental, you must explicitly import this package to use its contents.

  Definition Classes
    chisel3
-  package interface
  Definition Classes
    chisel3
-  package ltl
  Definition Classes
    chisel3
-  package naming
  Definition Classes
    chisel3
-  package probe
  Definition Classes
    chisel3
-  package properties

  The properties package includes functionality related to non-hardware data.

  The properties package includes functionality related to non-hardware data.

  This entire package is currently very experimental, so expect some rough edges and rapid API evolution.

  Definition Classes
    chisel3
-  package reflect
  Definition Classes
    chisel3
-  package simulator
  Definition Classes
    chisel3
-  package stage
  Definition Classes
    chisel3
-  package std
  Definition Classes
    chisel3
-  package testers

  The testers package provides the basic interface for chisel testers.

  The testers package provides the basic interface for chisel testers.

  Definition Classes
    chisel3
-  package util

  The util package provides extensions to core chisel for common hardware components and utility functions

  The util package provides extensions to core chisel for common hardware components and utility functions

  Definition Classes
    chisel3
- ActualDirection
- Aggregate
- AliasedAggregateFieldException
- AsyncReset
- AutoClonetypeException
- BiConnectException
- Binary
- BindingException
- Bits
- Bits
- BlackBox
- Bool
- Bool
- BoolFactory
- BuildInfo
- Bundle
- Character
- ChiselEnum
- ChiselException
- Clock
- Const
- Data
- Decimal
- Disable
- DontCare
- Element
- EnumType
- ExpectedAnnotatableException
- ExpectedChiselTypeException
- ExpectedHardwareException
- FirrtlFormat
- FixedIOBaseModule
- FixedIOExtModule
- FixedIORawModule
- FlatIO
- Flipped
- FullName
- HasTarget
- Hexadecimal
- IO
- IgnoreSeqInBundle
- ImplicitClock
- ImplicitReset
- Input
- InstanceId
- InternalErrorException
- KnownWidth
- Mem
- MemBase
- MixedDirectionAggregateException
- Module
- ModuleAspect
- MonoConnectException
- Mux
- Name
- Num
- NumObject
- Output
- PString
- Percent
- Printable
- PrintableHelper
- Printables
- RawModule
- RebindingException
- Record
- Reg
- RegInit
- RegNext
- RequireAsyncReset
- RequireSyncReset
- Reset
- ResetType
- SInt
- SInt
- SIntFactory
- SourceInfoDoc
- SpecifiedDirection
- SyncReadMem
- UInt
- UInt
- UIntFactory
- UnknownWidth
- Vec
- Vec
- VecFactory
- VecInit
- VecLike
- VerifPrintMacrosDoc
- VerificationStatement
- WhenContext
- Width
- Wire
- WireDefault
- WireFactory
- WireInit
- assert
- assume
- chiselTypeOf
- cover
- dontTouch
- emitVerilog
- fromBigIntToLiteral
- fromBooleanToLiteral
- fromIntToLiteral
- fromIntToWidth
- fromLongToLiteral
- fromStringToLiteral
- getVerilogString
- layer
- printf
- stop
- suppressEnumCastWarning
- when
- withClock
- withClockAndReset
- withDisable
- withReset
- withoutIO

c

chisel3

# PrintableHelper

###

#### implicit final class PrintableHelper extends AnyVal

Implicit for custom Printable string interpolator

Source
  package.scala

Linear Supertypes
AnyVal, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. PrintableHelper
2. AnyVal
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

### Instance Constructors

1.  new PrintableHelper(sc: StringContext)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     Any
2.  final def ##: Int
   Definition Classes
     Any
3.  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
4.  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()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  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 `f` interpolator. 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()
   Example:

   1.     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 `parts` string contains a backslash (`\`) character that does not start a valid escape sequence. throws IllegalArgumentException if the number of `parts` in the enclosing `StringContext` does not exceed the number of arguments `arg` by exactly 1.

8.  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
9.  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
10.  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
11.  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
12.  def getClass(): Class[_ <: AnyVal]
    Definition Classes
      AnyVal → Any
13.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
14.  def p(args: Any*): Printable

    Custom string interpolator for generating Printables: p"..." mimicks s"..." for non-Printable data)

15.  val sc: StringContext
16.  def toString(): String
    Definition Classes
      Any

### Deprecated Value Members

1.  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 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): (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.

### Inherited from AnyVal

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromPrintableHelper to any2stringadd[PrintableHelper]

### Inherited by implicit conversion StringFormat fromPrintableHelper to StringFormat[PrintableHelper]

### Inherited by implicit conversion Ensuring fromPrintableHelper to Ensuring[PrintableHelper]

### Inherited by implicit conversion ArrowAssoc fromPrintableHelper to ArrowAssoc[PrintableHelper]

### Ungrouped