abstract class ChiselEnum extends AnyRef
Ordering
- Alphabetic
- By Inheritance
Inherited
- ChiselEnum
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new ChiselEnum()
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 ChiselEnum toany2stringadd[ChiselEnum] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ChiselEnum, B)
- Implicit
- This member is added by an implicit conversion from ChiselEnum toArrowAssoc[ChiselEnum] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- macro def Value(id: UInt): Type
- Attributes
- protected
- macro def Value: Type
- Attributes
- protected
- def all: Seq[Type]
- def allNames: Seq[String]
- def apply(n: UInt)(implicit sourceInfo: SourceInfo): Type
Cast an UInt to the type of this Enum
Cast an UInt to the type of this Enum
- n
the UInt to cast
- returns
the equivalent Enum to the value of the cast UInt
- Note
will give a Chisel elaboration time warning if the argument could hit invalid states
- def apply(): Type
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def do_Value(name: String, id: UInt): Type
- Attributes
- protected
- def do_Value(name: String): Type
- Attributes
- protected
- def ensuring(cond: (ChiselEnum) => Boolean, msg: => Any): ChiselEnum
- Implicit
- This member is added by an implicit conversion from ChiselEnum toEnsuring[ChiselEnum] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ChiselEnum) => Boolean): ChiselEnum
- Implicit
- This member is added by an implicit conversion from ChiselEnum toEnsuring[ChiselEnum] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ChiselEnum
- Implicit
- This member is added by an implicit conversion from ChiselEnum toEnsuring[ChiselEnum] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ChiselEnum
- Implicit
- This member is added by an implicit conversion from ChiselEnum toEnsuring[ChiselEnum] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getWidth: Int
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def safe(n: UInt)(implicit sourceInfo: SourceInfo): (Type, Bool)
Safely cast an UInt to the type of this Enum
Safely cast an UInt to the type of this Enum
- n
the UInt to cast
- returns
the equivalent Enum to the value of the cast UInt and a Bool indicating if the Enum is valid
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- object Type
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ChiselEnum toStringFormat[ChiselEnum] 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): (ChiselEnum, B)
- Implicit
- This member is added by an implicit conversion from ChiselEnum toArrowAssoc[ChiselEnum] 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.