Packages

final case class Error(contractId: LfContractId, message: String) extends Alarm with TransactionSubmissionError with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Error
  2. TransactionSubmissionError
  3. TransactionError
  4. BaseCantonError
  5. TransactionProcessorError
  6. PrettyPrinting
  7. PrettyUtil
  8. ShowUtil
  9. ShowSyntax
  10. ToShowOps
  11. Serializable
  12. Product
  13. Equals
  14. WrapsProcessorError
  15. Alarm
  16. BaseAlarm
  17. BaseError
  18. LocationMixin
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Error(contractId: LfContractId, message: String)

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. 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. 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
  5. def asGoogleGrpcStatus(implicit loggingContext: ErrorLoggingContext): Status
    Definition Classes
    BaseCantonError
  6. def asGrpcError(implicit loggingContext: ErrorLoggingContext): StatusRuntimeException
    Definition Classes
    BaseCantonError
  7. def asGrpcError(implicit logger: ContextualizedErrorLogger): StatusRuntimeException
    Definition Classes
    BaseAlarm
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    AlarmBaseError
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. implicit val code: AlarmErrorCode

    The error code, usually passed in as implicit where the error class is defined

    The error code, usually passed in as implicit where the error class is defined

    Definition Classes
    AlarmBaseAlarmBaseError
  12. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    BaseCantonErrorBaseError
  13. val contractId: LfContractId
  14. 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
  15. def definiteAnswer: Boolean
    Definition Classes
    TransactionError
  16. final def definiteAnswerO: Option[Boolean]

    Parameter has no effect at the moment, as submission ranks are not supported.

    Parameter has no effect at the moment, as submission ranks are not supported. Setting to false for the time being.

    Definition Classes
    TransactionErrorBaseError
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. 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
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val location: Option[String]

    Contains the location where the error has been created.

    Contains the location where the error has been created.

    Definition Classes
    LocationMixin
  22. def log()(implicit loggingContext: ErrorLoggingContext): Unit
    Definition Classes
    BaseCantonError
  23. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  24. val message: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  28. 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
  29. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  30. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  31. 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
  32. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  33. 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
  34. def pretty: Pretty[TransactionSubmissionError]

    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
    TransactionSubmissionErrorPrettyPrinting
  35. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  36. 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
  37. 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
  38. 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
  39. 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
  40. 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
  41. def productElementNames: Iterator[String]
    Definition Classes
    Product
  42. def report()(implicit logger: ContextualizedErrorLogger): Unit

    Report the alarm to the logger.

    Report the alarm to the logger.

    Definition Classes
    BaseAlarm
  43. def reported()(implicit logger: ContextualizedErrorLogger): Error.this.type

    Reports the alarm to the logger.

    Reports the alarm to the logger.

    returns

    this alarm

    Definition Classes
    BaseAlarm
  44. def resources: Seq[(ErrorResource, String)]

    The resources related to this error

    The resources related to this error

    We return the set of resources via com.google.rpc.ResourceInfo. Override this method in order to return resource information via com.google.rpc.Status

    Definition Classes
    BaseError
  45. def retryable: Option[ErrorCategoryRetry]

    Returns retryability information of this particular error

    Returns retryability information of this particular error

    In some cases, error instances would like to provide custom retry intervals. This can be achieved by locally overriding this method.

    Do not use this to change the contract of the error categories. Non-retryable errors shouldn't be made retryable. Only use it for adjusting the retry intervals.

    Definition Classes
    BaseError
  46. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  47. def rpcStatusWithoutLoggingContext(): Status
    Definition Classes
    BaseCantonError
  48. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  49. 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
  50. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  51. val throwableO: Option[Throwable]

    An optional argument to log exceptions

    An optional argument to log exceptions

    If you want to log an exception as part of your error, then use the following example:

    object MyCode extends ErrorCode(id="SUPER_DUPER_ERROR") { case class MyError(someString: String, throwable: Throwable) extends SomeInternalError( cause = "Something failed with an exception bla", throwableO = Some(throwable) ) }

    NOTE: This throwable's details are not included the exception communicated to the gRPC clients so if you want them communicated, you need to explicitly add them to the e.g. context map or cause string.

    Definition Classes
    AlarmBaseError
  52. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  53. 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
  54. def underlyingProcessorError(): Option[ProcessorError]
  55. 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
  56. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  57. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  60. 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
    Deprecated

Inherited from TransactionError

Inherited from BaseCantonError

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WrapsProcessorError

Inherited from Alarm

Inherited from BaseAlarm

Inherited from BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped