Packages

trait SplainFormatting extends SplainFormatters

Self Type
Analyzer
Source
SplainFormatting.scala
Linear Supertypes
SplainFormatters, AnyRef, Any
Known Subclasses
erasure, treeChecker, ScaladocAnalyzer, InteractiveAnalyzer, Erasure, Duplicator, SpecializationDuplicator, Analyzer, Duplicators, TreeCheckers, TypeDiagnostics, SplainDiagnostics
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SplainFormatting
  2. SplainFormatters
  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

Type Members

  1. trait SpecialFormatter extends AnyRef
    Definition Classes
    SplainFormatters
  2. case class TypeParts(sym: Global.Symbol, tt: Global.Type) extends Product with Serializable

Value Members

  1. object ByNameFormatter extends Analyzer.SpecialFormatter
    Definition Classes
    SplainFormatters
  2. object FunctionFormatter extends Analyzer.SpecialFormatter
    Definition Classes
    SplainFormatters
  3. object Refined
    Definition Classes
    SplainFormatters
  4. object RefinedFormatter extends Analyzer.SpecialFormatter
    Definition Classes
    SplainFormatters
  5. object TupleFormatter extends Analyzer.SpecialFormatter
    Definition Classes
    SplainFormatters
  6. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def ##: Int
    Definition Classes
    AnyRef → Any
  8. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from SplainFormatting toany2stringadd[SplainFormatting] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  9. def ->[B](y: B): (SplainFormatting, B)
    Implicit
    This member is added by an implicit conversion from SplainFormatting toArrowAssoc[SplainFormatting] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  10. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def bracket[A](params: List[A]): String
  13. def breakInfix(types: List[Formatted]): TypeRepr

    Break a list produced by flattenInfix into lines by taking two elements at a time, then appending the terminal.

    Break a list produced by flattenInfix into lines by taking two elements at a time, then appending the terminal. If the expression's length is smaller than the threshold specified via plugin parameter, return a single line.

  14. val breakInfixLength: Int
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. def ctorNames(tpe: Global.Type): List[String]
  17. def dealias(tpe: Global.Type): Global.Type
  18. def decideBreak(flat: FlatType, broken: => BrokenType): TypeRepr
  19. def deepestLevel(chain: List[Analyzer.ImplicitError]): Int
  20. def ensuring(cond: (SplainFormatting) => Boolean, msg: => Any): SplainFormatting
    Implicit
    This member is added by an implicit conversion from SplainFormatting toEnsuring[SplainFormatting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (SplainFormatting) => Boolean): SplainFormatting
    Implicit
    This member is added by an implicit conversion from SplainFormatting toEnsuring[SplainFormatting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: => Any): SplainFormatting
    Implicit
    This member is added by an implicit conversion from SplainFormatting toEnsuring[SplainFormatting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): SplainFormatting
    Implicit
    This member is added by an implicit conversion from SplainFormatting toEnsuring[SplainFormatting] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. def extractArgs(tpe: Global.Type): collection.immutable.List[Global.Type]
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  28. def flattenInfix(tpe: Infix): List[Formatted]

    Turn a nested infix type structure into a flat list

    Turn a nested infix type structure into a flat list

    ::[A, ::[B, C]]] => List(A, ::, B, ::, C)
  29. def formatAuxSimple(tpe: Global.Type): (List[String], String)
  30. def formatDiff(left: Global.Type, right: Global.Type, top: Boolean): Formatted
  31. val formatDiffCache: FormatCache[(Global.Type, Global.Type, Boolean), Formatted]
  32. def formatDiffImpl(found: Global.Type, req: Global.Type, top: Boolean): Formatted
  33. def formatDiffInfix(left: Global.Type, right: Global.Type, top: Boolean): Formatted
  34. def formatDiffSimple(left: Global.Type, right: Global.Type): Formatted
  35. def formatDiffSpecial(left: Global.Type, right: Global.Type, top: Boolean): Option[Formatted]
  36. def formatFunction(args: List[String]): String
  37. def formatImplicitChain(chain: List[Analyzer.ImplicitError]): List[String]
  38. def formatImplicitChainFlat(chain: List[Analyzer.ImplicitError]): List[String]
  39. def formatImplicitChainTreeCompact(chain: List[Analyzer.ImplicitError]): Option[List[String]]
  40. def formatImplicitChainTreeFull(chain: List[Analyzer.ImplicitError]): List[String]
  41. def formatImplicitError(param: Global.Symbol, errors: List[Analyzer.ImplicitError], annotationMsg: String): String
  42. def formatIndentTree(chain: List[Analyzer.ImplicitError], baseIndent: Int): List[String]
  43. def formatInfix[A](path: List[String], simple: String, left: A, right: A, top: Boolean)(rec: (A, Boolean) => Formatted): Formatted
  44. def formatNestedImplicit(err: Analyzer.ImplicitError): (String, List[String], Int)
  45. def formatNestedImplicits(errors: List[Analyzer.ImplicitError]): collection.immutable.List[String]

    Remove duplicates and special cases that should not be shown.

    Remove duplicates and special cases that should not be shown. In some cases, candidates are reported twice, once as Foo.f and once as f. ImplicitError.equals checks the simple names for identity, which is suboptimal, but works for 99% of cases. Special cases are handled in hideImpError

  46. def formatNonConfBounds(err: NonconformantBounds): List[String]
  47. def formatNormalSimple(tpe: Global.Type): (List[String], String)
  48. def formatRefinement(sym: Global.Symbol): String
  49. def formatSimpleType(tpe: Global.Type): (List[String], String)
  50. def formatSpecial[A](tpe: Global.Type, simple: String, args: List[A], formattedArgs: => List[Formatted], top: Boolean)(rec: (A, Boolean) => Formatted): Option[Formatted]
  51. def formatType(tpe: Global.Type, top: Boolean): Formatted
    Definition Classes
    SplainFormatting → SplainFormatters
  52. val formatTypeCache: FormatCache[(Global.Type, Boolean), Formatted]
  53. def formatTypeImpl(tpe: Global.Type, top: Boolean): Formatted
  54. def formatWithInfix[A](tpe: Global.Type, args: List[A], top: Boolean)(rec: (A, Boolean) => Formatted): Formatted
  55. def formattedDiff(left: Formatted, right: Formatted): String
  56. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. def hideImpError(error: Analyzer.ImplicitError): Boolean
  59. def implicitMessage(param: Global.Symbol, annotationMsg: String): List[String]
  60. def indent(lines: List[String], n: Int = 1, prefix: String = " "): collection.immutable.List[String]
  61. def indentLine(line: String, n: Int = 1, prefix: String = " "): String
  62. def indentTree(tree: List[(String, List[String], Int)], baseIndent: Int): List[String]
  63. def isAux(tpe: Global.Type): Boolean
  64. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  65. def isRefined(tpe: Global.Type): Boolean
  66. def isSymbolic(tpe: Global.Type): Boolean
  67. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. def pathPrefix: (List[String]) => String
  71. def qualifiedName(path: List[String], name: FormattedName): String
  72. def sanitizePath(path: List[String]): List[String]
  73. def showFormatted(tpe: Formatted): String
  74. def showFormattedL(tpe: Formatted, break: Boolean): TypeRepr
  75. val showFormattedLCache: FormatCache[(Formatted, Boolean), TypeRepr]
  76. def showFormattedLImpl(tpe: Formatted, break: Boolean): TypeRepr
  77. def showFormattedQualified(path: List[String], name: FormattedName): TypeRepr
  78. def showFuncParams(args: List[String]): String
  79. def showRefined(parents: List[String], decls: List[String]): String
  80. def showTuple(args: List[String]): String
  81. def showType(tpe: Global.Type): String
  82. def showTypeApply(cons: String, args: List[TypeRepr], break: Boolean): TypeRepr

    If the args of an applied type constructor are multiline, create separate lines for the constructor name and the closing bracket; else return a single line.

  83. def showTypeBreakL(tpe: Global.Type): List[String]
  84. val specialFormatters: List[Analyzer.SpecialFormatter]
  85. def splitChains(errors: List[Analyzer.ImplicitError]): List[List[Analyzer.ImplicitError]]
  86. def stripModules(path: List[String], name: FormattedName): String
  87. def stripType(tpe: Global.Type): (List[String], String)
  88. def symbolPath(sym: Global.Symbol): List[String]
  89. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  90. def toString(): String
    Definition Classes
    AnyRef → Any
  91. def truncateDecls(decls: List[Formatted]): Boolean
  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  95. def wrapParens(expr: String, top: Boolean): String
  96. def wrapParensRepr(tpe: TypeRepr, top: Boolean): TypeRepr

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSplainFormatting to any2stringadd[SplainFormatting]

Inherited by implicit conversion StringFormat fromSplainFormatting to StringFormat[SplainFormatting]

Inherited by implicit conversion Ensuring fromSplainFormatting to Ensuring[SplainFormatting]

Inherited by implicit conversion ArrowAssoc fromSplainFormatting to ArrowAssoc[SplainFormatting]

Ungrouped