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
- Alphabetic
- By Inheritance
Inherited
- Pretty
- PrettyInstances
- PrettyUtil
- ShowUtil
- ShowSyntax
- ToShowOps
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Type Members
- implicit class PrettyOps[T] extends AnyRef
Convenience methods for Pretty types.
- implicit class ShowAnyRefSyntax extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowEitherSyntax[L, R] extends AnyRef
Enables the syntax
show"${myEither.showMerged}".Enables the syntax
show"${myEither.showMerged}".- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
- Definition Classes
- ShowUtil
- implicit class ShowOptionSyntax[T] extends AnyRef
- Definition Classes
- ShowUtil
- implicit class ShowProductSyntax extends AnyRef
- Definition Classes
- ShowUtil
- Annotations
- @SuppressWarnings()
- implicit class ShowStringSyntax extends StringOperators
- Definition Classes
- ShowUtil
- 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
- abstract class StringOperators extends AnyRef
Enables syntax like
show"This is a string: ${myString.doubleQuoted}"andshow"This is a hash: ${myHash.readableHash}".Enables syntax like
show"This is a string: ${myString.doubleQuoted}"andshow"This is a hash: ${myHash.readableHash}".- Definition Classes
- ShowUtil
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val DefaultEscapeUnicode: Boolean
- val DefaultHeight: Int
- val DefaultIndent: Int
- val DefaultPprinter: PPrinter
Default PPrinter used to implement
toStringandshowmethods. - val DefaultShowFieldNames: Boolean
- val DefaultWidth: Int
- 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
- Instances of
- def apply[A](implicit pretty: Pretty[A]): Pretty[A]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def indicateOmittedFields[T]: (T) => Option[Tree]
Use this to indicate that you've omitted fields from pretty printing
Use this to indicate that you've omitted fields from pretty printing
- Definition Classes
- PrettyUtil
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
A tree only written if not matching the default value
A tree only written if not matching the default value
- Definition Classes
- PrettyUtil
- def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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
- implicit def prettyActiveLedgerState[T](implicit arg0: Pretty[T]): Pretty[ActiveLedgerState[T]]
- Definition Classes
- PrettyInstances
- implicit def prettyArray[T](implicit arg0: Pretty[T]): Pretty[Array[T]]
- Definition Classes
- PrettyInstances
- implicit def prettyBoolean: Pretty[Boolean]
- Definition Classes
- PrettyInstances
- implicit val prettyByteString: Pretty[ByteString]
- Definition Classes
- PrettyInstances
- implicit def prettyChangeId: Pretty[ChangeId]
- Definition Classes
- PrettyInstances
- implicit def prettyCompletion: Pretty[Completion]
- Definition Classes
- PrettyInstances
- implicit def prettyContractId: Pretty[ContractId[_]]
- Definition Classes
- PrettyInstances
- implicit def prettyDumpInfo: Pretty[DumpInfo]
- Definition Classes
- PrettyInstances
- implicit def prettyDumpable: Pretty[Dumpable]
- Definition Classes
- PrettyInstances
- implicit def prettyDuration: Pretty[Duration]
- Definition Classes
- PrettyInstances
- implicit def prettyEither[L, R](implicit arg0: Pretty[L], arg1: Pretty[R]): Pretty[Either[L, R]]
- Definition Classes
- PrettyInstances
- implicit def prettyGrpcStatus: Pretty[Status]
- Definition Classes
- PrettyInstances
- def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
- Definition Classes
- PrettyUtil
- implicit def prettyInstant: Pretty[Instant]
- Definition Classes
- PrettyInstances
- implicit def prettyInt: Pretty[Int]
- Definition Classes
- PrettyInstances
- implicit val prettyJDuration: Pretty[Duration]
- Definition Classes
- PrettyInstances
- implicit def prettyJLong: Pretty[Long]
- Definition Classes
- PrettyInstances
- implicit val prettyKeyInputError: Pretty[KeyInputError]
- Definition Classes
- PrettyInstances
- implicit def prettyLedgerApplicationId: Pretty[LedgerApplicationId]
- Definition Classes
- PrettyInstances
- implicit val prettyLedgerBoundary: Pretty[LedgerBoundary]
- Definition Classes
- PrettyInstances
- implicit def prettyLedgerConfiguration: Pretty[Configuration]
- Definition Classes
- PrettyInstances
- implicit val prettyLedgerOffset: Pretty[LedgerOffset]
- Definition Classes
- PrettyInstances
- implicit def prettyLedgerString: Pretty[LedgerString]
- Definition Classes
- PrettyInstances
- implicit def prettyLedgerTimeModel: Pretty[LedgerTimeModel]
- Definition Classes
- PrettyInstances
- implicit def prettyLfContractId: Pretty[LfContractId]
- Definition Classes
- PrettyInstances
- implicit def prettyLfDottedName: Pretty[DottedName]
- Definition Classes
- PrettyInstances
- implicit def prettyLfGlobalKey: Pretty[LfGlobalKey]
- Definition Classes
- PrettyInstances
- implicit def prettyLfHash: Pretty[LfHash]
- Definition Classes
- PrettyInstances
- implicit def prettyLfIdentifier: Pretty[Identifier]
- Definition Classes
- PrettyInstances
- implicit def prettyLfParticipantId: Pretty[ParticipantId]
- Definition Classes
- PrettyInstances
- implicit def prettyLfPartyId: Pretty[LfPartyId]
- Definition Classes
- PrettyInstances
- implicit def prettyLfQualifiedName: Pretty[QualifiedName]
- Definition Classes
- PrettyInstances
- implicit def prettyLfTimestamp: Pretty[LfTimestamp]
- Definition Classes
- PrettyInstances
- implicit def prettyLfTransactionVersion: Pretty[LfTransactionVersion]
- Definition Classes
- PrettyInstances
- implicit def prettyLong: Pretty[Long]
- Definition Classes
- PrettyInstances
- implicit def prettyMap[K, V](implicit arg0: Pretty[K], arg1: Pretty[V]): Pretty[Map[K, V]]
- Definition Classes
- PrettyInstances
- 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
- implicit val prettyNodeId: Pretty[LfNodeId]
- Definition Classes
- PrettyInstances
- implicit def prettyNonempty[T](implicit arg0: Pretty[T]): Pretty[NonEmpty[T]]
- Definition Classes
- PrettyInstances
- 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
- 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
- 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
- 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
- implicit def prettyOption[T](implicit arg0: Pretty[T]): Pretty[Option[T]]
- Definition Classes
- PrettyInstances
- implicit def prettyPackageId: Pretty[PackageId]
- Definition Classes
- PrettyInstances
- implicit def prettyPair[T1, T2](implicit arg0: Pretty[T1], arg1: Pretty[T2]): Pretty[(T1, T2)]
- Definition Classes
- PrettyInstances
- implicit val prettyPort: Pretty[Port]
- Definition Classes
- PrettyInstances
- implicit def prettyPrettyPrinting[T <: PrettyPrinting]: Pretty[T]
- Definition Classes
- PrettyInstances
- Annotations
- @SuppressWarnings()
- implicit def prettyPrimitiveParty: Pretty[Party]
- Definition Classes
- PrettyInstances
- implicit val prettyReadServiceOffset: Pretty[Offset]
- Definition Classes
- PrettyInstances
- implicit val prettyRefinedNumeric: Pretty[RefinedNumeric[_]]
- Definition Classes
- PrettyInstances
- implicit def prettyRpcStatus: Pretty[Status]
- Definition Classes
- PrettyInstances
- implicit def prettySeq[T](implicit arg0: Pretty[T]): Pretty[Seq[T]]
- Definition Classes
- PrettyInstances
- implicit val prettyServingStatus: Pretty[ServingStatus]
- Definition Classes
- PrettyInstances
- implicit def prettySet[T](implicit arg0: Pretty[T]): Pretty[Set[T]]
- Definition Classes
- PrettyInstances
- 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
- def prettyString: Pretty[String]
- Definition Classes
- PrettyInstances
- implicit def prettyThrowable: Pretty[Throwable]
- Definition Classes
- PrettyInstances
- implicit val prettyTraceContext: Pretty[TraceContext]
- Definition Classes
- PrettyInstances
- implicit def prettyTree[T <: Tree]: Pretty[T]
- Definition Classes
- PrettyInstances
- implicit def prettyTriple[T1, T2, T3](implicit arg0: Pretty[T1], arg1: Pretty[T2], arg2: Pretty[T3]): Pretty[(T1, T2, T3)]
- Definition Classes
- PrettyInstances
- implicit def prettyURI: Pretty[URI]
- Definition Classes
- PrettyInstances
- implicit val prettyUnit: Pretty[Unit]
- Definition Classes
- PrettyInstances
- implicit val prettyUuid: Pretty[UUID]
- Definition Classes
- PrettyInstances
- implicit def prettyV2DeduplicationPeriod: Pretty[DeduplicationPeriod]
- Definition Classes
- PrettyInstances
- implicit lazy val prettyValue: Pretty[Value]
- Definition Classes
- PrettyInstances
- implicit lazy val prettyVersionedValue: Pretty[VersionedValue]
- Definition Classes
- PrettyInstances
- implicit val prettyW3CTraceContext: Pretty[W3CTraceContext]
- Definition Classes
- PrettyInstances
- implicit final def showInterpolator(sc: StringContext): ShowInterpolator
- Definition Classes
- ShowSyntax
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
- Definition Classes
- ToShowOps
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
- Definition Classes
- PrettyUtil
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])