Packages

object Pretty extends ShowUtil with PrettyUtil with PrettyInstances

The companion object collects everything you might need for implementing Pretty instances.

Import this as follows:

implicit val prettyMyClass: Pretty[MyClass] = {
  import Pretty._
  ...
}

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pretty
  2. PrettyInstances
  3. PrettyUtil
  4. ShowUtil
  5. ShowSyntax
  6. ToShowOps
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class PrettyOps[T] extends AnyRef

    Convenience methods for Pretty types.

  2. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  3. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  4. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  5. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  6. implicit class ShowStringSyntax extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil
  7. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DefaultHeight: Int
  5. val DefaultIndent: Int
  6. val DefaultPprinter: PPrinter

    Default PPrinter used to implement toString and show methods.

  7. val DefaultWidth: Int
  8. def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  9. def apply[A](implicit pretty: Pretty[A]): Pretty[A]
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  22. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  23. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  24. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  25. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  26. implicit def prettyArray[T](implicit arg0: Pretty[T]): Pretty[Array[T]]
    Definition Classes
    PrettyInstances
  27. implicit def prettyBoolean: Pretty[Boolean]
    Definition Classes
    PrettyInstances
  28. implicit val prettyByteString: Pretty[ByteString]
    Definition Classes
    PrettyInstances
  29. implicit def prettyCompletion: Pretty[Completion]
    Definition Classes
    PrettyInstances
  30. implicit def prettyDumpInfo: Pretty[DumpInfo]
    Definition Classes
    PrettyInstances
  31. implicit def prettyDumpable: Pretty[Dumpable]
    Definition Classes
    PrettyInstances
  32. implicit def prettyDuration: Pretty[Duration]
    Definition Classes
    PrettyInstances
  33. implicit def prettyEither[L, R](implicit arg0: Pretty[L], arg1: Pretty[R]): Pretty[Either[L, R]]
    Definition Classes
    PrettyInstances
  34. implicit def prettyGrpcStatus: Pretty[Status]
    Definition Classes
    PrettyInstances
  35. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  36. implicit def prettyInstant: Pretty[Instant]
    Definition Classes
    PrettyInstances
  37. implicit def prettyInt: Pretty[Int]
    Definition Classes
    PrettyInstances
  38. implicit def prettyJDuration: Pretty[Duration]
    Definition Classes
    PrettyInstances
  39. implicit val prettyLedgerBoundary: Pretty[LedgerBoundary]
    Definition Classes
    PrettyInstances
  40. implicit def prettyLedgerConfiguration: Pretty[Configuration]
    Definition Classes
    PrettyInstances
  41. implicit val prettyLedgerOffset: Pretty[LedgerOffset]
    Definition Classes
    PrettyInstances
  42. implicit def prettyLedgerString: Pretty[LedgerString]
    Definition Classes
    PrettyInstances
  43. implicit def prettyLedgerTimeModel: Pretty[LedgerTimeModel]
    Definition Classes
    PrettyInstances
  44. implicit def prettyLfContractId: Pretty[LfContractId]
    Definition Classes
    PrettyInstances
  45. implicit def prettyLfDottedName: Pretty[DottedName]
    Definition Classes
    PrettyInstances
  46. implicit def prettyLfGlobalKey: Pretty[LfGlobalKey]
    Definition Classes
    PrettyInstances
  47. implicit def prettyLfHash: Pretty[LfHash]
    Definition Classes
    PrettyInstances
  48. implicit def prettyLfIdentifier: Pretty[Identifier]
    Definition Classes
    PrettyInstances
  49. implicit def prettyLfParticipantId: Pretty[ParticipantId]
    Definition Classes
    PrettyInstances
  50. implicit def prettyLfPartyId: Pretty[LfPartyId]
    Definition Classes
    PrettyInstances
  51. implicit def prettyLfQualifiedName: Pretty[QualifiedName]
    Definition Classes
    PrettyInstances
  52. implicit def prettyLfTimestamp: Pretty[LfTimestamp]
    Definition Classes
    PrettyInstances
  53. implicit def prettyLfTransactionVersion: Pretty[LfTransactionVersion]
    Definition Classes
    PrettyInstances
  54. implicit def prettyLong: Pretty[Long]
    Definition Classes
    PrettyInstances
  55. implicit def prettyMap[K, V](implicit arg0: Pretty[K], arg1: Pretty[V]): Pretty[Map[K, V]]
    Definition Classes
    PrettyInstances
  56. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  57. implicit val prettyNodeId: Pretty[LfNodeId]
    Definition Classes
    PrettyInstances
  58. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  59. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  60. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  61. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  62. implicit def prettyOption[T](implicit arg0: Pretty[T]): Pretty[Option[T]]
    Definition Classes
    PrettyInstances
  63. implicit def prettyPackageId: Pretty[PackageId]
    Definition Classes
    PrettyInstances
  64. implicit def prettyPair[T1, T2](implicit arg0: Pretty[T1], arg1: Pretty[T2]): Pretty[(T1, T2)]
    Definition Classes
    PrettyInstances
  65. implicit def prettyPrettyPrinting[T <: PrettyPrinting]: Pretty[T]
    Definition Classes
    PrettyInstances
    Annotations
    @SuppressWarnings()
  66. implicit def prettyPrimitiveContractId: Pretty[ContractId[_]]
    Definition Classes
    PrettyInstances
  67. implicit def prettyPrimitiveParty: Pretty[Party]
    Definition Classes
    PrettyInstances
  68. implicit val prettyReadServiceOffset: Pretty[Offset]
    Definition Classes
    PrettyInstances
  69. implicit def prettyRpcStatus: Pretty[Status]
    Definition Classes
    PrettyInstances
  70. implicit def prettySeq[T](implicit arg0: Pretty[T]): Pretty[Seq[T]]
    Definition Classes
    PrettyInstances
  71. implicit def prettySet[T](implicit arg0: Pretty[T]): Pretty[Set[T]]
    Definition Classes
    PrettyInstances
  72. implicit def prettyShown: Pretty[Shown]

    Makes the syntax from com.digitalasset.canton.util.ShowUtil accessible in places where a Pretty is expected.

    Makes the syntax from com.digitalasset.canton.util.ShowUtil accessible in places where a Pretty is expected.

    Definition Classes
    PrettyInstances
  73. def prettyString: Pretty[String]
    Definition Classes
    PrettyInstances
  74. implicit def prettyThrowable: Pretty[Throwable]
    Definition Classes
    PrettyInstances
  75. implicit def prettyTree[T <: Tree]: Pretty[T]
    Definition Classes
    PrettyInstances
  76. implicit def prettyTriple[T1, T2, T3](implicit arg0: Pretty[T1], arg1: Pretty[T2], arg2: Pretty[T3]): Pretty[(T1, T2, T3)]
    Definition Classes
    PrettyInstances
  77. implicit def prettyURI: Pretty[URI]
    Definition Classes
    PrettyInstances
  78. implicit def prettyUpdate: Pretty[Update]
    Definition Classes
    PrettyInstances
  79. implicit def prettyUpdateCommandRejected: Pretty[CommandRejected]
    Definition Classes
    PrettyInstances
  80. implicit def prettyUpdateConfigurationChangeRejected: Pretty[ConfigurationChangeRejected]
    Definition Classes
    PrettyInstances
  81. implicit def prettyUpdateConfigurationChanged: Pretty[ConfigurationChanged]
    Definition Classes
    PrettyInstances
  82. implicit def prettyUpdatePartyAddedToParticipant: Pretty[PartyAddedToParticipant]
    Definition Classes
    PrettyInstances
  83. implicit def prettyUpdatePartyAllocationRejected: Pretty[PartyAllocationRejected]
    Definition Classes
    PrettyInstances
  84. implicit def prettyUpdatePublicPackageUpload: Pretty[PublicPackageUpload]
    Definition Classes
    PrettyInstances
  85. implicit def prettyUpdatePublicPackageUploadRejected: Pretty[PublicPackageUploadRejected]
    Definition Classes
    PrettyInstances
  86. implicit def prettyUpdateTransactionAccepted: Pretty[TransactionAccepted]
    Definition Classes
    PrettyInstances
  87. implicit val prettyUuid: Pretty[UUID]
    Definition Classes
    PrettyInstances
  88. implicit def prettyV1RejectionReason: Pretty[RejectionReason]
    Definition Classes
    PrettyInstances
  89. implicit def prettyV1SubmitterInfo: Pretty[SubmitterInfo]
    Definition Classes
    PrettyInstances
  90. implicit def prettyV1TransactionMeta: Pretty[TransactionMeta]
    Definition Classes
    PrettyInstances
  91. implicit def prettyValue[Cid](implicit arg0: Pretty[Cid]): Pretty[Value[Cid]]
    Definition Classes
    PrettyInstances
  92. implicit def prettyVersionedValue[Cid](implicit arg0: Pretty[Cid]): Pretty[VersionedValue[Cid]]
    Definition Classes
    PrettyInstances
  93. implicit val prettyW3CTraceContext: Pretty[W3CTraceContext]
    Definition Classes
    PrettyInstances
  94. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  95. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  96. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  97. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  98. def toString(): String
    Definition Classes
    AnyRef → Any
  99. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  100. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  101. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  102. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  103. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  104. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from PrettyInstances

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from AnyRef

Inherited from Any

Ungrouped