t

firrtl.options

RegisteredLibrary

trait RegisteredLibrary extends HasShellOptions

A class that includes options that should be exposed as a group at the top level.

Source
Registration.scala
Note

To complete registration, include an entry in src/main/resources/META-INF/services/firrtl.options.RegisteredLibrary

Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RegisteredLibrary
  2. HasShellOptions
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract def name: String

    The name of this library.

    The name of this library.

    This will be used when generating help text.

  2. abstract def options: Seq[ShellOption[_]]

    A sequence of options provided

    A sequence of options provided

    Definition Classes
    HasShellOptions

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toany2stringadd[RegisteredLibrary] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RegisteredLibrary, B)
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toArrowAssoc[RegisteredLibrary] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def addOptions(p: OptionParser[AnnotationSeq]): Unit

    Add all shell (command line) options to an option parser

    Add all shell (command line) options to an option parser

    p

    an option parser

    Definition Classes
    HasShellOptions
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def ensuring(cond: (RegisteredLibrary) => Boolean, msg: => Any): RegisteredLibrary
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toEnsuring[RegisteredLibrary] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (RegisteredLibrary) => Boolean): RegisteredLibrary
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toEnsuring[RegisteredLibrary] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): RegisteredLibrary
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toEnsuring[RegisteredLibrary] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): RegisteredLibrary
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toEnsuring[RegisteredLibrary] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toStringFormat[RegisteredLibrary] 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): (RegisteredLibrary, B)
    Implicit
    This member is added by an implicit conversion from RegisteredLibrary toArrowAssoc[RegisteredLibrary] 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 HasShellOptions

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRegisteredLibrary to any2stringadd[RegisteredLibrary]

Inherited by implicit conversion StringFormat fromRegisteredLibrary to StringFormat[RegisteredLibrary]

Inherited by implicit conversion Ensuring fromRegisteredLibrary to Ensuring[RegisteredLibrary]

Inherited by implicit conversion ArrowAssoc fromRegisteredLibrary to ArrowAssoc[RegisteredLibrary]

Ungrouped