Packages

class TraceContext extends HasProtoV0[v0.TraceContext] with HasVersionedWrapper[VersionedTraceContext] with Equals with Serializable with NoCopy with PrettyPrinting

Container for values tracing operations through canton.

Linear Supertypes
PrettyPrinting, PrettyUtil, ShowUtil, ShowSyntax, ToShowOps, NoCopy, Serializable, Equals, HasVersionedWrapper[VersionedTraceContext], HasVersionedToByteString, HasProtoV0[v0.TraceContext], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TraceContext
  2. PrettyPrinting
  3. PrettyUtil
  4. ShowUtil
  5. ShowSyntax
  6. ToShowOps
  7. NoCopy
  8. Serializable
  9. Equals
  10. HasVersionedWrapper
  11. HasVersionedToByteString
  12. HasProtoV0
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

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

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

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

    Definition Classes
    ShowUtil
  3. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  6. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  7. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. 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
  9. abstract class StringOperators 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

Value Members

  1. 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
  2. lazy val asW3CTraceContext: Option[W3CTraceContext]
  3. def canEqual(that: Any): Boolean
    Definition Classes
    TraceContext → Equals
    Annotations
    @SuppressWarnings()
  4. val context: Context
  5. 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
  6. def equals(that: Any): Boolean
    Definition Classes
    TraceContext → Equals → AnyRef → Any
  7. def hashCode(): Int
    Definition Classes
    TraceContext → AnyRef → Any
  8. def intoGrpcContext[A](fn: => A): A

    Expose this trace context into the GRPC context

  9. 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
  10. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  11. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  12. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  13. 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
  14. def pretty: Pretty[TraceContext]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    TraceContext → PrettyPrinting
  15. 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
  16. 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
  17. 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
  18. 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
  19. 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
  20. 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
  21. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  22. 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
  23. def showTraceId: Shown
  24. def toByteArray(version: ProtocolVersion): Array[Byte]

    Yields a byte array representation of the corresponding Versioned... wrapper of this instance.

    Yields a byte array representation of the corresponding Versioned... wrapper of this instance.

    Definition Classes
    HasVersionedWrapper
  25. def toByteString(version: ProtocolVersion): ByteString

    Yields a byte string representation of the corresponding Versioned... wrapper of this instance.

    Yields a byte string representation of the corresponding Versioned... wrapper of this instance.

    Definition Classes
    HasVersionedWrapper → HasVersionedToByteString
  26. def toDamlTelemetryContext(implicit tracer: Tracer): TelemetryContext

    Convert to ledger-api server's telemetry context to facilitate integration

  27. def toProtoV0: v0.TraceContext

    Yields the proto representation of the class.

    Yields the proto representation of the class.

    Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.MemoizedEvidence).

    Definition Classes
    TraceContext → HasProtoV0
  28. def toProtoVersioned(version: ProtocolVersion): VersionedTraceContext

    Yields the proto representation of the class inside a Versioned... wrapper.

    Yields the proto representation of the class inside a Versioned... wrapper.

    Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.MemoizedEvidence).

    Definition Classes
    TraceContext → HasVersionedWrapper
  29. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  30. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  31. lazy val traceId: Option[String]
  32. 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
  33. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  34. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  35. def writeToFile(outputFile: String, version: ProtocolVersion = ProtocolVersion.latest): Unit

    Writes the byte string representation of the corresponding Versioned... wrapper of this instance to a file.

    Writes the byte string representation of the corresponding Versioned... wrapper of this instance to a file.

    Definition Classes
    HasVersionedWrapper