Scala Compiler2.13.17 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package typechecker
  Definition Classes
    nsc
-  package splain
  Definition Classes
    typechecker
- Applied
- BrokenType
- ByName
- Decl
- DeclDiff
- Diff
- FlatType
- FormatCache
- Formatted
- FormattedName
- FunctionForm
- Infix
- InfixName
- Qualified
- RefinedForm
- Simple
- SimpleName
- SplainData
- SplainDiagnostics
- SplainErrors
- SplainFormatters
- SplainFormatting
- TupleForm
- TypeRepr
- UnitForm

t

scala.tools.nsc.typechecker.splain

# SplainFormatting

###
Companion object SplainFormatting

#### 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 ImplicitErrorLink(fromTree: Analyzer.ImplicitError, fromHistory: Analyzer.DivergentImplicitTypeError) extends Product with Serializable
3.  case class ImplicitErrorTree(error: Analyzer.ImplicitError, children: collection.immutable.Seq[Analyzer.ImplicitErrorTree] = Nil) extends Product with Serializable
4.  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.  implicit def asSimpleName(s: String): SimpleName
    Definition Classes
      SplainFormatters
13.  def bracket[A](params: collection.immutable.List[A]): String
14.  def breakInfix(types: collection.immutable.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.

15.  val breakInfixLength: Int
16.  def clone(): AnyRef
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.CloneNotSupportedException]) @native()
17.  def ctorNames(tpe: Global.Type): collection.immutable.List[String]
18.  def dealias(tpe: Global.Type): Global.Type
19.  def decideBreak(flat: FlatType, broken: => BrokenType): TypeRepr
20.  def deepestLevel(chain: collection.immutable.List[Analyzer.ImplicitError]): Int
21.  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
22.  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
23.  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
24.  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
25.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
26.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
27.  def extractArgs(tpe: Global.Type): collection.immutable.List[Global.Type]
28.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
29.  def flattenInfix(tpe: Infix): collection.immutable.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)

30.  def formatAuxSimple(tpe: Global.Type): (collection.immutable.List[String], String)
31.  def formatDiff(left: Global.Type, right: Global.Type, top: Boolean): Formatted
32.  val formatDiffCache: FormatCache[(Global.Type, Global.Type, Boolean), Formatted]
33.  def formatDiffImpl(found: Global.Type, req: Global.Type, top: Boolean): Formatted
34.  def formatDiffInfix(left: Global.Type, right: Global.Type, top: Boolean): Formatted
35.  def formatDiffSimple(left: Global.Type, right: Global.Type): Formatted
36.  def formatDiffSpecial(left: Global.Type, right: Global.Type, top: Boolean): Option[Formatted]
37.  def formatFunction(args: collection.immutable.List[String]): String
38.  def formatImplicitChainFlat(chain: collection.immutable.List[Analyzer.ImplicitError]): collection.immutable.List[String]
39.  def formatImplicitChainTreeFull(chain: collection.immutable.List[Analyzer.ImplicitError]): collection.immutable.List[String]
40.  def formatImplicitError(param: Global.Symbol, errors: collection.immutable.List[Analyzer.ImplicitError], annotationMsg: String): String
41.  def formatIndentTree(chain: collection.immutable.List[Analyzer.ImplicitError], baseIndent: Int): collection.immutable.List[String]
42.  def formatInfix[A](path: collection.immutable.List[String], simple: String, left: A, right: A, top: Boolean)(rec: (A, Boolean) => Formatted): Formatted
43.  def formatNestedImplicit(err: Analyzer.ImplicitError): (String, collection.immutable.List[String], Int)
44.  def formatNonConfBounds(err: NonconformantBounds): collection.immutable.List[String]
45.  def formatNormalSimple(tpe: Global.Type): (collection.immutable.List[String], String)
46.  def formatRefinement(sym: Global.Symbol): String
47.  def formatSimpleType(tpe: Global.Type): (collection.immutable.List[String], String)
48.  def formatSpecial[A](tpe: Global.Type, simple: String, args: collection.immutable.List[A], formattedArgs: => collection.immutable.List[Formatted], top: Boolean)(rec: (A, Boolean) => Formatted): Option[Formatted]
49.  def formatType(tpe: Global.Type, top: Boolean): Formatted
    Definition Classes
      SplainFormatting → SplainFormatters
50.  val formatTypeCache: FormatCache[(Global.Type, Boolean), Formatted]
51.  def formatTypeImpl(tpe: Global.Type, top: Boolean): Formatted
52.  def formatWithInfix[A](tpe: Global.Type, args: collection.immutable.List[A], top: Boolean)(rec: (A, Boolean) => Formatted): Formatted
53.  def formattedDiff(left: Formatted, right: Formatted): String
54.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
55.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
56.  def hideImpError(error: Analyzer.ImplicitError): Boolean
57.  def implicitMessage(param: Global.Symbol, annotationMsg: String): collection.immutable.List[String]
58.  def indent(lines: collection.immutable.List[String], n: Int = 1, prefix: String = " "): collection.immutable.List[String]
59.  def indentLine(line: String, n: Int = 1, prefix: String = " "): String
60.  def indentTree(tree: collection.immutable.List[(String, collection.immutable.List[String], Int)], baseIndent: Int): collection.immutable.List[String]
61.  def isAux(tpe: Global.Type): Boolean
62.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
63.  def isRefined(tpe: Global.Type): Boolean
64.  def isSymbolic(tpe: Global.Type): Boolean
65.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
66.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
67.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
68.  def pathPrefix: (collection.immutable.List[String]) => String
69.  def qualifiedName(path: collection.immutable.List[String], name: FormattedName): String
70.  def sanitizePath(path: collection.immutable.List[String]): collection.immutable.List[String]
71.  def showFormatted(tpe: Formatted): String
72.  def showFormattedL(tpe: Formatted, break: Boolean): TypeRepr
73.  val showFormattedLCache: FormatCache[(Formatted, Boolean), TypeRepr]
74.  def showFormattedLImpl(tpe: Formatted, break: Boolean): TypeRepr
75.  def showFormattedQualified(path: collection.immutable.List[String], name: FormattedName): TypeRepr
76.  def showFuncParams(args: collection.immutable.List[String]): String
77.  def showRefined(parents: collection.immutable.List[String], decls: collection.immutable.List[String]): String
78.  def showTuple(args: collection.immutable.List[String]): String
79.  def showType(tpe: Global.Type): String
80.  def showTypeApply(cons: String, args: collection.immutable.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.

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

### 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